Compartir a través de

DatabaseAccounts/sqlDatabases/clientEncryptionKeys 2023-11-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 los recursos

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-11-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any()
    }
  }
}

Valores de propiedad

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
primario 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 más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: sqlDatabases
properties Propiedades para crear y actualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obligatorio)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nombre Descripción Valor
resource El formato JSON estándar de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nombre Descripción Valor
encryptionAlgorithm Algoritmo de cifrado que se usará junto con esta clave de cifrado de cliente para cifrar o descifrar datos. string
id Nombre de ClientEncryptionKey string
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. Para Bicep, puede usar la función any().

KeyWrapMetadata

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

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 los recursos

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

{
  "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 propiedad

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nombre Descripción Value
type Tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'
apiVersion La versión de la API de recursos '2023-11-15'
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON.		 string (obligatorio)
properties Propiedades para crear y actualizar ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obligatorio)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nombre Descripción Valor
resource Formato JSON estándar de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

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

KeyWrapMetadata

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

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

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

Formato de los recursos

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-11-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 propiedad

databaseAccounts/sqlDatabases/clientEncryptionKeys

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

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nombre Descripción Valor
resource Formato JSON estándar de clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

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

KeyWrapMetadata

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