Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2023-03-15

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-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 propiedad

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nombre Descripción Valor
recurso El formato JSON estándar de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nombre Descripción Valor
encryptionAlgorithm Algoritmo de cifrado que se usará junto con esta clave de cifrado de cliente para cifrar o descifrar datos. cuerda
identificación Nombre de ClientEncryptionKey cuerda
keyWrapMetadata Metadatos del proveedor de ajuste que se puede usar para desencapsular la clave de cifrado de cliente ajustada. KeyWrapMetadata
wrappedDataEncryptionKey Forma ajustada (cifrada) de la clave representada como una matriz de bytes. cualquier

KeyWrapMetadata

Nombre Descripción Valor
algoritmo Algoritmo usado en el ajuste y desencapsulado de la clave de cifrado de datos. cuerda
nombre Nombre de KeyEncryptionKey asociado (también conocido como CustomerManagedKey). cuerda
tipo ProviderName de KeyStoreProvider. cuerda
valor Referencia o vínculo a KeyEncryptionKey. cuerda

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: databaseAccounts/sqlDatabases
Propiedades Propiedades para crear y actualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obligatorio)

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nombre Descripción Valor
recurso El formato JSON estándar de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nombre Descripción Valor
encryptionAlgorithm Algoritmo de cifrado que se usará junto con esta clave de cifrado de cliente para cifrar o descifrar datos. cuerda
identificación Nombre de ClientEncryptionKey cuerda
keyWrapMetadata Metadatos del proveedor de ajuste que se puede usar para desencapsular la clave de cifrado de cliente ajustada. KeyWrapMetadata
wrappedDataEncryptionKey Forma ajustada (cifrada) de la clave representada como una matriz de bytes. cualquier

KeyWrapMetadata

Nombre Descripción Valor
algoritmo Algoritmo usado en el ajuste y desencapsulado de la clave de cifrado de datos. cuerda
nombre Nombre de KeyEncryptionKey asociado (también conocido como CustomerManagedKey). cuerda
tipo ProviderName de KeyStoreProvider. cuerda
valor Referencia o vínculo a KeyEncryptionKey. cuerda

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nombre Descripción Valor
apiVersion La versión de api '2023-03-15'
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades para crear y actualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obligatorio)
tipo El tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, agregue el siguiente terraform a la plantilla.

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

Valores de propiedad

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nombre Descripción Valor
recurso El formato JSON estándar de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nombre Descripción Valor
encryptionAlgorithm Algoritmo de cifrado que se usará junto con esta clave de cifrado de cliente para cifrar o descifrar datos. cuerda
identificación Nombre de ClientEncryptionKey cuerda
keyWrapMetadata Metadatos del proveedor de ajuste que se puede usar para desencapsular la clave de cifrado de cliente ajustada. KeyWrapMetadata
wrappedDataEncryptionKey Forma ajustada (cifrada) de la clave representada como una matriz de bytes. cualquier

KeyWrapMetadata

Nombre Descripción Valor
algoritmo Algoritmo usado en el ajuste y desencapsulado de la clave de cifrado de datos. cuerda
nombre Nombre de KeyEncryptionKey asociado (también conocido como CustomerManagedKey). cuerda
tipo ProviderName de KeyStoreProvider. cuerda
valor Referencia o vínculo a KeyEncryptionKey. cuerda

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: databaseAccounts/sqlDatabases
Propiedades Propiedades para crear y actualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obligatorio)
tipo El tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15"