Microsoft.Synapse workspaces/encryptionProtector

Bicep resource definition

The workspaces/encryptionProtector resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.Synapse/workspaces/encryptionProtector@2021-06-01' = {
  name: 'current'
  parent: resourceSymbolicName
  properties: {
    serverKeyName: 'string'
    serverKeyType: 'string'
  }
}

Property values

workspaces/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: workspaces
properties Resource properties. EncryptionProtectorProperties

EncryptionProtectorProperties

Name Description Value
serverKeyName The name of the server key. string
serverKeyType The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. 'AzureKeyVault'
'ServiceManaged' (required)

ARM template resource definition

The workspaces/encryptionProtector resource type can be deployed to:

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

Resource format

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

{
  "type": "Microsoft.Synapse/workspaces/encryptionProtector",
  "apiVersion": "2021-06-01",
  "name": "current",
  "properties": {
    "serverKeyName": "string",
    "serverKeyType": "string"
  }
}

Property values

workspaces/encryptionProtector

Name Description Value
type The resource type 'Microsoft.Synapse/workspaces/encryptionProtector'
apiVersion The resource api version '2021-06-01'
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
serverKeyName The name of the server key. string
serverKeyType The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. 'AzureKeyVault'
'ServiceManaged' (required)

Terraform (AzAPI provider) resource definition

The workspaces/encryptionProtector resource type can be deployed to:

  • Resource groups

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

Resource format

To create a Microsoft.Synapse/workspaces/encryptionProtector resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/encryptionProtector@2021-06-01"
  name = "current"
  parent_id = "string"
  body = jsonencode({
    properties = {
      serverKeyName = "string"
      serverKeyType = "string"
    }
  })
}

Property values

workspaces/encryptionProtector

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

EncryptionProtectorProperties

Name Description Value
serverKeyName The name of the server key. string
serverKeyType The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. "AzureKeyVault"
"ServiceManaged" (required)