Microsoft.Sql servers/keys 2023-05-01-preview
Bicep resource definition
The servers/keys resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/keys resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/keys@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
serverKeyType: 'string'
uri: 'string'
}
}
Property values
servers/keys
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Valid characters: Must be in format: VaultName_KeyName_KeyVersion. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: servers |
| properties | Resource properties. | ServerKeyProperties |
ServerKeyProperties
| Name | Description | Value |
|---|---|---|
| serverKeyType | The server key type like 'ServiceManaged', 'AzureKeyVault'. | 'AzureKeyVault' 'ServiceManaged' (required) |
| uri | The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create an Azure SQL Server, with data encryption protector |
This template creates an Azure SQL server, activates the data encryption protector using a given key stored in a given Key Vault |
ARM template resource definition
The servers/keys resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/keys resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/keys",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"serverKeyType": "string",
"uri": "string"
}
}
Property values
servers/keys
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/servers/keys' |
| apiVersion | The resource api version | '2023-05-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Valid characters: Must be in format: VaultName_KeyName_KeyVersion. |
| properties | Resource properties. | ServerKeyProperties |
ServerKeyProperties
| Name | Description | Value |
|---|---|---|
| serverKeyType | The server key type like 'ServiceManaged', 'AzureKeyVault'. | 'AzureKeyVault' 'ServiceManaged' (required) |
| uri | The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create an Azure SQL Server, with data encryption protector |
This template creates an Azure SQL server, activates the data encryption protector using a given key stored in a given Key Vault |
Terraform (AzAPI provider) resource definition
The servers/keys resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/keys resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/keys@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
serverKeyType = "string"
uri = "string"
}
})
}
Property values
servers/keys
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/servers/keys@2023-05-01-preview" |
| name | The resource name | string (required) Valid characters: Must be in format: VaultName_KeyName_KeyVersion. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: servers |
| properties | Resource properties. | ServerKeyProperties |
ServerKeyProperties
| Name | Description | Value |
|---|---|---|
| serverKeyType | The server key type like 'ServiceManaged', 'AzureKeyVault'. | "AzureKeyVault" "ServiceManaged" (required) |
| uri | The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' | string |