Partilhar via

Base de dados Microsoft.DocumentDBContas/sqlDatabases/clientEncryptionKeys 2023-09-15

  • Artigo

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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-09-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any()
    }
  }
}

Valores de propriedade

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: sqlDatabases
propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obrigatório)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nome Descrição Valor
recurso O formato JSON padrão de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obrigatório)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nome Descrição Valor
encryptionAlgorithm Algoritmo de encriptação que será utilizado juntamente com esta chave de encriptação de cliente para encriptar/desencriptar dados. string
ID Nome da ClientEncryptionKey string
keyWrapMetadata Metadados do fornecedor de encapsulamento que podem ser utilizados para desembrulhar a chave de encriptação de cliente encapsulada. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (encriptada) da chave representada como uma matriz de bytes. Para o Bicep, pode utilizar a função any( ).

KeyWrapMetadata

Nome Descrição Valor
algoritmo Algoritmo utilizado para encapsular e desembrulhar a chave de encriptação de dados. string
name O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). string
tipo ProviderName de KeyStoreProvider. string
valor Referência/ligação para KeyEncryptionKey. string

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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-09-15",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Valores de propriedade

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"
apiVersion A versão da API de recursos '2023-09-15'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.		 cadeia (obrigatório)
propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obrigatório)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nome Descrição Valor
recurso O formato JSON padrão de uma ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obrigatório)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nome Descrição Valor
encryptionAlgorithm Algoritmo de encriptação que será utilizado juntamente com esta chave de encriptação de cliente para encriptar/desencriptar dados. string
ID Nome da ClientEncryptionKey string
keyWrapMetadata Metadados para o fornecedor de encapsulamento que podem ser utilizados para desembrulhar a chave de encriptação de cliente encapsulada. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (encriptada) da chave representada como uma matriz de bytes.

KeyWrapMetadata

Nome Descrição Valor
algoritmo Algoritmo utilizado na moldagem e anulação da moldagem da chave de encriptação de dados. string
name O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). string
tipo ProviderName de KeyStoreProvider. string
valor Referência/ligação para KeyEncryptionKey. string

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-09-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
      }
    }
  })
}

Valores de propriedade

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: sqlDatabases
propriedades Propriedades para criar e atualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obrigatório)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nome Descrição Valor
recurso O formato JSON padrão de uma ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obrigatório)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nome Descrição Valor
encryptionAlgorithm Algoritmo de encriptação que será utilizado juntamente com esta chave de encriptação de cliente para encriptar/desencriptar dados. string
ID Nome da ClientEncryptionKey string
keyWrapMetadata Metadados para o fornecedor de encapsulamento que podem ser utilizados para desembrulhar a chave de encriptação de cliente encapsulada. KeyWrapMetadata
wrappedDataEncryptionKey Forma encapsulada (encriptada) da chave representada como uma matriz de bytes.

KeyWrapMetadata

Nome Descrição Valor
algoritmo Algoritmo utilizado na moldagem e anulação da moldagem da chave de encriptação de dados. string
name O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). string
tipo ProviderName de KeyStoreProvider. string
valor Referência/ligação para KeyEncryptionKey. string