Microsoft.Synapse workspaces/keys 2021-04-01-preview

Bicep resource definition

The workspaces/keys 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.Synapse/workspaces/keys resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/keys@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    isActiveCMK: bool
    keyVaultUrl: 'string'
  }
}

Property Values

Microsoft.Synapse/workspaces/keys

Name Description Value
name The resource name string (required)
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 Keys resource properties KeyProperties

KeyProperties

Name Description Value
isActiveCMK Used to activate the workspace after a customer managed key is provided. bool
keyVaultUrl The Key Vault Url of the workspace key. string

ARM template resource definition

The workspaces/keys resource type can be deployed with operations that target:

Usage Examples

Resource format

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

{
  "type": "Microsoft.Synapse/workspaces/keys",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "isActiveCMK": "bool",
    "keyVaultUrl": "string"
  }
}

Property Values

Microsoft.Synapse/workspaces/keys

Name Description Value
apiVersion The api version '2021-04-01-preview'
name The resource name string (required)
properties Keys resource properties KeyProperties
type The resource type 'Microsoft.Synapse/workspaces/keys'

KeyProperties

Name Description Value
isActiveCMK Used to activate the workspace after a customer managed key is provided. bool
keyVaultUrl The Key Vault Url of the workspace key. string

Terraform (AzAPI provider) resource definition

The workspaces/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.Synapse/workspaces/keys resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/keys@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      isActiveCMK = bool
      keyVaultUrl = "string"
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/keys

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties Keys resource properties KeyProperties
type The resource type "Microsoft.Synapse/workspaces/keys@2021-04-01-preview"

KeyProperties

Name Description Value
isActiveCMK Used to activate the workspace after a customer managed key is provided. bool
keyVaultUrl The Key Vault Url of the workspace key. string
  • Last updated on