Compartilhar via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-11-15

  • Artigo

Definição de recurso do Bicep

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 de log de alterações.

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-11-15' = {
  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

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nome Descrição Valor
encryptionAlgorithm Algoritmo de criptografia que será usado junto com essa chave de criptografia do cliente para criptografar/descriptografar dados. corda
id Nome do ClientEncryptionKey corda
keyWrapMetadata Metadados para o provedor de encapsulamento que podem ser usados para desembrulhar a chave de criptografia do cliente encapsulada. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. qualquer

KeyWrapMetadata

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (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 o recurso do tipo: databaseAccounts/sqlDatabases
Propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obrigatório)

Definição de recurso de modelo do 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 de log de alterações.

Formato de recurso

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

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

Valores de propriedade

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nome Descrição Valor
encryptionAlgorithm Algoritmo de criptografia que será usado junto com essa chave de criptografia do cliente para criptografar/descriptografar dados. corda
id Nome do ClientEncryptionKey corda
keyWrapMetadata Metadados para o provedor de encapsulamento que podem ser usados para desembrulhar a chave de criptografia do cliente encapsulada. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. qualquer

KeyWrapMetadata

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrição Valor
apiVersion A versão da API '2023-11-15'
nome O nome do recurso cadeia de caracteres (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 recurso do Terraform (provedor de 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 de log de alterações.

Formato de recurso

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

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

Valores de propriedade

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nome Descrição Valor
encryptionAlgorithm Algoritmo de criptografia que será usado junto com essa chave de criptografia do cliente para criptografar/descriptografar dados. corda
id Nome do ClientEncryptionKey corda
keyWrapMetadata Metadados para o provedor de encapsulamento que podem ser usados para desembrulhar a chave de criptografia do cliente encapsulada. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. qualquer

KeyWrapMetadata

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do 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-11-15"