Microsoft.Sql servers/encryptionProtector 2021-02-01-preview

  • Article

Bicep resource definition

The servers/encryptionProtector resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/encryptionProtector resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/encryptionProtector@2021-02-01-preview' = {
  name: 'current'
  parent: resourceSymbolicName
  properties: {
    autoRotationEnabled: bool
    serverKeyName: 'string'
    serverKeyType: 'string'
  }
}

Property values

servers/encryptionProtector

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'current'
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. EncryptionProtectorProperties

EncryptionProtectorProperties

Name Description Value
autoRotationEnabled Key auto rotation opt-in flag. Either true or false. bool
serverKeyName The name of the server key. string
serverKeyType The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. 'AzureKeyVault'
'ServiceManaged' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure SQL Server, with data encryption protector

Deploy to Azure		 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/encryptionProtector resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/encryptionProtector resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "apiVersion": "2021-02-01-preview",
  "name": "current",
  "properties": {
    "autoRotationEnabled": "bool",
    "serverKeyName": "string",
    "serverKeyType": "string"
  }
}

Property values

servers/encryptionProtector

Name Description Value
type The resource type 'Microsoft.Sql/servers/encryptionProtector'
apiVersion The resource api version '2021-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'current'
properties Resource properties. EncryptionProtectorProperties

EncryptionProtectorProperties

Name Description Value
autoRotationEnabled Key auto rotation opt-in flag. Either true or false. bool
serverKeyName The name of the server key. string
serverKeyType The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. 'AzureKeyVault'
'ServiceManaged' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure SQL Server, with data encryption protector

Deploy to Azure		 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/encryptionProtector 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/encryptionProtector resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/encryptionProtector@2021-02-01-preview"
  name = "current"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoRotationEnabled = bool
      serverKeyName = "string"
      serverKeyType = "string"
    }
  })
}

Property values

servers/encryptionProtector

Name Description Value
type The resource type "Microsoft.Sql/servers/encryptionProtector@2021-02-01-preview"
name The resource name "current"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
properties Resource properties. EncryptionProtectorProperties

EncryptionProtectorProperties

Name Description Value
autoRotationEnabled Key auto rotation opt-in flag. Either true or false. bool
serverKeyName The name of the server key. string
serverKeyType The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. "AzureKeyVault"
"ServiceManaged" (required)