Microsoft.CognitiveServices accounts/encryptionScopes

• Latest
• 2025-04-01-preview
• 2024-10-01
• 2024-06-01-preview
• 2024-04-01-preview
• 2023-10-01-preview

Bicep resource definition

The accounts/encryptionScopes 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.CognitiveServices/accounts/encryptionScopes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.CognitiveServices/accounts/encryptionScopes@2025-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    keySource: 'string'
    keyVaultProperties: {
      identityClientId: 'string'
      keyName: 'string'
      keyVaultUri: 'string'
      keyVersion: 'string'
    }
    state: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

EncryptionScopeProperties

Name	Description	Value
keySource	Enumerates the possible value of keySource for Encryption	'Microsoft.CognitiveServices' 'Microsoft.KeyVault'
keyVaultProperties	Properties of KeyVault	KeyVaultProperties
state	The encryptionScope state.	'Disabled' 'Enabled'

EncryptionScopeTags

Name	Description	Value

KeyVaultProperties

Name	Description	Value
identityClientId		string
keyName	Name of the Key from KeyVault	string
keyVaultUri	Uri of KeyVault	string
keyVersion	Version of the Key from KeyVault	string

Microsoft.CognitiveServices/accounts/encryptionScopes

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (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: accounts
properties	Properties of Cognitive Services EncryptionScope.	EncryptionScopeProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ARM template resource definition

The accounts/encryptionScopes 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.CognitiveServices/accounts/encryptionScopes resource, add the following JSON to your template.

{
  "type": "Microsoft.CognitiveServices/accounts/encryptionScopes",
  "apiVersion": "2025-04-01-preview",
  "name": "string",
  "properties": {
    "keySource": "string",
    "keyVaultProperties": {
      "identityClientId": "string",
      "keyName": "string",
      "keyVaultUri": "string",
      "keyVersion": "string"
    },
    "state": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

EncryptionScopeProperties

Name	Description	Value
keySource	Enumerates the possible value of keySource for Encryption	'Microsoft.CognitiveServices' 'Microsoft.KeyVault'
keyVaultProperties	Properties of KeyVault	KeyVaultProperties
state	The encryptionScope state.	'Disabled' 'Enabled'

EncryptionScopeTags

Name	Description	Value

KeyVaultProperties

Name	Description	Value
identityClientId		string
keyName	Name of the Key from KeyVault	string
keyVaultUri	Uri of KeyVault	string
keyVersion	Version of the Key from KeyVault	string

Microsoft.CognitiveServices/accounts/encryptionScopes

Name	Description	Value
apiVersion	The api version	'2025-04-01-preview'
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
properties	Properties of Cognitive Services EncryptionScope.	EncryptionScopeProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.CognitiveServices/accounts/encryptionScopes'

Användningsexempel

Terraform (AzAPI provider) resource definition

The accounts/encryptionScopes 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.CognitiveServices/accounts/encryptionScopes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CognitiveServices/accounts/encryptionScopes@2025-04-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      keySource = "string"
      keyVaultProperties = {
        identityClientId = "string"
        keyName = "string"
        keyVaultUri = "string"
        keyVersion = "string"
      }
      state = "string"
    }
  }
}

Property Values

EncryptionScopeProperties

Name	Description	Value
keySource	Enumerates the possible value of keySource for Encryption	'Microsoft.CognitiveServices' 'Microsoft.KeyVault'
keyVaultProperties	Properties of KeyVault	KeyVaultProperties
state	The encryptionScope state.	'Disabled' 'Enabled'

EncryptionScopeTags

Name	Description	Value

KeyVaultProperties

Name	Description	Value
identityClientId		string
keyName	Name of the Key from KeyVault	string
keyVaultUri	Uri of KeyVault	string
keyVersion	Version of the Key from KeyVault	string

Microsoft.CognitiveServices/accounts/encryptionScopes

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: accounts
properties	Properties of Cognitive Services EncryptionScope.	EncryptionScopeProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.CognitiveServices/accounts/encryptionScopes@2025-04-01-preview"