Partilhar via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-03-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any(Azure.Bicep.Types.Concrete.AnyType)
    }
  }
}

Valores de propriedade

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Designação Descrição Valor
recurso O formato JSON padrão de um ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obrigatório)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Designação Descrição Valor
encryptionAlgoritmo Algoritmo de encriptação que será usado juntamente com esta chave de encriptação do cliente para encriptar/desencriptar dados. string
ID Nome da ClientEncryptionKey string
keyWrapMetadata Metadados para o provedor de encapsulamento que podem ser usados para desempacotar a chave de criptografia do cliente encapsulado. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. qualquer

KeyWrapMetadata

Designação Descrição Valor
algoritmo Algoritmo usado no encapsulamento e desempacotamento da chave de criptografia de dados. string
Designação O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). string
tipo ProviderName de KeyStoreProvider. string
valor Referência / link para o KeyEncryptionKey. string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: databaseAccounts/sqlDatabases
propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obrigatório)

Definição de recurso de modelo ARM

O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Valores de propriedade

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Designação Descrição Valor
recurso O formato JSON padrão de um ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obrigatório)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Designação Descrição Valor
encryptionAlgoritmo Algoritmo de encriptação que será usado juntamente com esta chave de encriptação do cliente para encriptar/desencriptar dados. string
ID Nome da ClientEncryptionKey string
keyWrapMetadata Metadados para o provedor de encapsulamento que podem ser usados para desempacotar a chave de criptografia do cliente encapsulado. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. qualquer

KeyWrapMetadata

Designação Descrição Valor
algoritmo Algoritmo usado no encapsulamento e desempacotamento da chave de criptografia de dados. string
Designação O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). string
tipo ProviderName de KeyStoreProvider. string
valor Referência / link para o KeyEncryptionKey. string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Designação Descrição Valor
apiVersion A versão api '2023-03-01-pré-visualização'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  })
}

Valores de propriedade

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Designação Descrição Valor
recurso O formato JSON padrão de um ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obrigatório)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Designação Descrição Valor
encryptionAlgoritmo Algoritmo de encriptação que será usado juntamente com esta chave de encriptação do cliente para encriptar/desencriptar dados. string
ID Nome da ClientEncryptionKey string
keyWrapMetadata Metadados para o provedor de encapsulamento que podem ser usados para desempacotar a chave de criptografia do cliente encapsulado. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. qualquer

KeyWrapMetadata

Designação Descrição Valor
algoritmo Algoritmo usado no encapsulamento e desempacotamento da chave de criptografia de dados. string
Designação O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). string
tipo ProviderName de KeyStoreProvider. string
valor Referência / link para o KeyEncryptionKey. string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: databaseAccounts/sqlDatabases
propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obrigatório)
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-01-preview"