Database Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa databaseAccounts/sqlDatabases/clientEncryptionKeys può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: sqlDatabases
properties Proprietà per creare e aggiornare ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obbligatorio)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nome Descrizione Valore
Risorsa Formato JSON standard di clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obbligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nome Descrizione Valore
encryptionAlgorithm Algoritmo di crittografia che verrà usato insieme a questa chiave di crittografia client per crittografare/decrittografare i dati. string
id Nome di ClientEncryptionKey string
keyWrapMetadata Metadati per il provider di wrapping che può essere usato per annullare il wrapping della chiave di crittografia del client di cui è stato eseguito il wrapping. KeyWrapMetadata
wrappedDataEncryptionKey Forma di cui è stato eseguito il wrapping (crittografato) della chiave rappresentata come matrice di byte. Per Bicep, è possibile usare la funzione any().

KeyWrapMetadata

Nome Descrizione Valore
algoritmo Algoritmo utilizzato per il wrapping e l'annullamento del wrapping della chiave di crittografia dei dati. string
name Nome di KeyEncryptionKey associato (noto anche come CustomerManagedKey). string
type ProviderName di KeyStoreProvider. string
Valore Riferimento/collegamento a KeyEncryptionKey. string

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa databaseAccounts/sqlDatabases/clientEncryptionKeys può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'
apiVersion Versione dell'API della risorsa '2024-05-15'
name Nome della risorsa

Informazioni su come impostare nomi e tipi per le risorse figlio nei modelli di Resource Manager JSON.		 stringa (obbligatorio)
properties Proprietà per creare e aggiornare ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obbligatorio)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nome Descrizione Valore
Risorsa Formato JSON standard di clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obbligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nome Descrizione Valore
encryptionAlgorithm Algoritmo di crittografia che verrà usato insieme a questa chiave di crittografia client per crittografare/decrittografare i dati. string
id Nome di ClientEncryptionKey string
keyWrapMetadata Metadati per il provider di wrapping che può essere usato per annullare il wrapping della chiave di crittografia del client di cui è stato eseguito il wrapping. KeyWrapMetadata
wrappedDataEncryptionKey Forma di cui è stato eseguito il wrapping (crittografato) della chiave rappresentata come matrice di byte.

KeyWrapMetadata

Nome Descrizione Valore
algoritmo Algoritmo utilizzato per il wrapping e l'annullamento del wrapping della chiave di crittografia dei dati. string
name Nome di KeyEncryptionKey associato (noto anche come CustomerManagedKey). string
type ProviderName di KeyStoreProvider. string
Valore Riferimento/collegamento a KeyEncryptionKey. string

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa databaseAccounts/sqlDatabases/clientEncryptionKeys può essere distribuito con operazioni destinate:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15"
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: sqlDatabases
properties Proprietà per creare e aggiornare ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obbligatorio)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Nome Descrizione Valore
Risorsa Formato JSON standard di clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obbligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nome Descrizione Valore
encryptionAlgorithm Algoritmo di crittografia che verrà usato insieme a questa chiave di crittografia client per crittografare/decrittografare i dati. string
id Nome di ClientEncryptionKey string
keyWrapMetadata Metadati per il provider di wrapping che può essere usato per annullare il wrapping della chiave di crittografia del client di cui è stato eseguito il wrapping. KeyWrapMetadata
wrappedDataEncryptionKey Forma di cui è stato eseguito il wrapping (crittografato) della chiave rappresentata come matrice di byte.

KeyWrapMetadata

Nome Descrizione Valore
algoritmo Algoritmo utilizzato per il wrapping e l'annullamento del wrapping della chiave di crittografia dei dati. string
name Nome di KeyEncryptionKey associato (aka CustomerManagedKey). string
type ProviderName di KeyStoreProvider. string
Valore Riferimento/collegamento a KeyEncryptionKey. string