Condividi tramite

Database Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2024-11-15

  • Articolo

Definizione di risorsa Bicep

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-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)
    }
  }
}

Valori delle proprietà

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nome Descrizione Valore
risorsa Formato JSON standard di clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obbligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nome Descrizione Valore
encryptionAlgorithm Algoritmo di crittografia che verrà usato insieme a questa chiave di crittografia client per crittografare/decrittografare i dati. corda
Id Nome di ClientEncryptionKey corda
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 wrapping (crittografata) della chiave rappresentata come matrice di byte. qualunque

KeyWrapMetadata

Nome Descrizione Valore
algoritmo Algoritmo usato per il wrapping e l'annullamento del wrapping della chiave di crittografia dei dati. corda
nome Nome di KeyEncryptionKey associato (noto anche come CustomerManagedKey). corda
digitare ProviderName di KeyStoreProvider. corda
valore Riferimento/collegamento a KeyEncryptionKey. corda

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrizione Valore
nome Nome della risorsa stringa (obbligatorio)
genitore 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 all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: databaseAccounts/sqlDatabases
proprietà Proprietà per creare e aggiornare ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obbligatorio)

Definizione di risorsa del modello di Resource Manager

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato 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-11-15",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Valori delle proprietà

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nome Descrizione Valore
risorsa Formato JSON standard di clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obbligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nome Descrizione Valore
encryptionAlgorithm Algoritmo di crittografia che verrà usato insieme a questa chiave di crittografia client per crittografare/decrittografare i dati. corda
Id Nome di ClientEncryptionKey corda
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 wrapping (crittografata) della chiave rappresentata come matrice di byte. qualunque

KeyWrapMetadata

Nome Descrizione Valore
algoritmo Algoritmo usato per il wrapping e l'annullamento del wrapping della chiave di crittografia dei dati. corda
nome Nome di KeyEncryptionKey associato (noto anche come CustomerManagedKey). corda
digitare ProviderName di KeyStoreProvider. corda
valore Riferimento/collegamento a KeyEncryptionKey. corda

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nome Descrizione Valore
apiVersion Versione dell'API '2024-11-15'
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà per creare e aggiornare ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obbligatorio)
digitare Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Definizione di risorsa Terraform (provider AzAPI)

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

  • gruppi di risorse

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

Formato 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-11-15"
  name = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  })
}

Valori delle proprietà

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nome Descrizione Valore
risorsa Formato JSON standard di clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obbligatorio)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nome Descrizione Valore
encryptionAlgorithm Algoritmo di crittografia che verrà usato insieme a questa chiave di crittografia client per crittografare/decrittografare i dati. corda
Id Nome di ClientEncryptionKey corda
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 wrapping (crittografata) della chiave rappresentata come matrice di byte. qualunque

KeyWrapMetadata

Nome Descrizione Valore
algoritmo Algoritmo usato per il wrapping e l'annullamento del wrapping della chiave di crittografia dei dati. corda
nome Nome di KeyEncryptionKey associato (noto anche come CustomerManagedKey). corda
digitare ProviderName di KeyStoreProvider. corda
valore Riferimento/collegamento a KeyEncryptionKey. corda

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

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