Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getServerKey
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getServerKey

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a server key.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2015-05-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getServerKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getServerKey(args: GetServerKeyArgs, opts?: InvokeOptions): Promise<GetServerKeyResult>
function getServerKeyOutput(args: GetServerKeyOutputArgs, opts?: InvokeOptions): Output<GetServerKeyResult>
Copy
def get_server_key(key_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   server_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetServerKeyResult
def get_server_key_output(key_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   server_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetServerKeyResult]
Copy
func LookupServerKey(ctx *Context, args *LookupServerKeyArgs, opts ...InvokeOption) (*LookupServerKeyResult, error)
func LookupServerKeyOutput(ctx *Context, args *LookupServerKeyOutputArgs, opts ...InvokeOption) LookupServerKeyResultOutput
Copy

> Note: This function is named LookupServerKey in the Go SDK.

public static class GetServerKey 
{
    public static Task<GetServerKeyResult> InvokeAsync(GetServerKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetServerKeyResult> Invoke(GetServerKeyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServerKeyResult> getServerKey(GetServerKeyArgs args, InvokeOptions options)
public static Output<GetServerKeyResult> getServerKey(GetServerKeyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getServerKey
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

KeyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server key to be retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
KeyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server key to be retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
keyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server key to be retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
keyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server key to be retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
key_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server key to be retrieved.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
keyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server key to be retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getServerKey Result

The following output properties are available:

AutoRotationEnabled bool
Key auto rotation opt-in flag. Either true or false.
AzureApiVersion string
The Azure API version of the resource.
CreationDate string
The server key creation date.
Id string
Resource ID.
Kind string
Kind of encryption protector. This is metadata used for the Azure portal experience.
Location string
Resource location.
Name string
Resource name.
Subregion string
Subregion of the server key.
Thumbprint string
Thumbprint of the server key.
Type string
Resource type.
AutoRotationEnabled bool
Key auto rotation opt-in flag. Either true or false.
AzureApiVersion string
The Azure API version of the resource.
CreationDate string
The server key creation date.
Id string
Resource ID.
Kind string
Kind of encryption protector. This is metadata used for the Azure portal experience.
Location string
Resource location.
Name string
Resource name.
Subregion string
Subregion of the server key.
Thumbprint string
Thumbprint of the server key.
Type string
Resource type.
autoRotationEnabled Boolean
Key auto rotation opt-in flag. Either true or false.
azureApiVersion String
The Azure API version of the resource.
creationDate String
The server key creation date.
id String
Resource ID.
kind String
Kind of encryption protector. This is metadata used for the Azure portal experience.
location String
Resource location.
name String
Resource name.
subregion String
Subregion of the server key.
thumbprint String
Thumbprint of the server key.
type String
Resource type.
autoRotationEnabled boolean
Key auto rotation opt-in flag. Either true or false.
azureApiVersion string
The Azure API version of the resource.
creationDate string
The server key creation date.
id string
Resource ID.
kind string
Kind of encryption protector. This is metadata used for the Azure portal experience.
location string
Resource location.
name string
Resource name.
subregion string
Subregion of the server key.
thumbprint string
Thumbprint of the server key.
type string
Resource type.
auto_rotation_enabled bool
Key auto rotation opt-in flag. Either true or false.
azure_api_version str
The Azure API version of the resource.
creation_date str
The server key creation date.
id str
Resource ID.
kind str
Kind of encryption protector. This is metadata used for the Azure portal experience.
location str
Resource location.
name str
Resource name.
subregion str
Subregion of the server key.
thumbprint str
Thumbprint of the server key.
type str
Resource type.
autoRotationEnabled Boolean
Key auto rotation opt-in flag. Either true or false.
azureApiVersion String
The Azure API version of the resource.
creationDate String
The server key creation date.
id String
Resource ID.
kind String
Kind of encryption protector. This is metadata used for the Azure portal experience.
location String
Resource location.
name String
Resource name.
subregion String
Subregion of the server key.
thumbprint String
Thumbprint of the server key.
type String
Resource type.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native