New-AzCosmosDbClientEncryptionKey

New-AzCosmosDbClientEncryptionKey
    -ResourceGroupName <String>
    -AccountName <String>
    -DatabaseName <String>
    -Name <String>
    -EncryptionAlgorithmName <String>
    -KeyWrapMetadata <PSSqlKeyWrapMetadata>
    [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-AzCosmosDbClientEncryptionKey
    -Name <String>
    -EncryptionAlgorithmName <String>
    -KeyWrapMetadata <PSSqlKeyWrapMetadata>
    -SqlDatabaseObject <PSSqlDatabaseGetResults>
    [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-AzCosmosDbClientEncryptionKey crée une clé de chiffrement du client CosmosDB.

$myKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV1","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP"))
New-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -EncryptionAlgorithmName "AEAD_AES_256_CBC_HMAC_SHA256" -KeyWrapMetadata $myKeyWrapMetadataObject

Name     : myContainerName
Id       : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource

Cet exemple montre comment une nouvelle clé est créée. Si KeyEncryptionKeyResolver n’est pas passé Azure Key Vault KeyResolver est utilisé par défaut. La première commande crée un objet KeyWrapMetadata avec le nom myKekV1 de type AZURE_KEY_VAULT avec la valeur définie sur l’ID de https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 clé et le type d’algorithme « RSA-OAEP » utilisés pour chiffrer la clé. Dans la deuxième commande, une nouvelle clé est créée avec le nom défini dans la variable myClientEncryptionKeyName et avec keyWrapMetadata défini sur la valeur retournée par la première commande.

$myKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV1","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP"))
$azureKeyVaultKeyResolver = [Azure.Security.KeyVault.Keys.Cryptography.KeyResolver]::new([Azure.Identity.DefaultAzureCredential]::new())
New-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -EncryptionAlgorithmName "AEAD_AES_256_CBC_HMAC_SHA256" -KeyWrapMetadata $myKeyWrapMetadataObject -KeyEncryptionKeyResolver $azureKeyVaultKeyResolver

Name     : myContainerName
Id       : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource

Cet exemple montre comment une nouvelle clé est créée et comment KeyEncryptionKeyResolver peut être passée en tant que paramètre. La première commande crée un objet KeyWrapMetadata avec le nom myKekV1 de type AZURE_KEY_VAULT avec la valeur définie sur l’ID de https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 clé et le type d’algorithme « RSA-OAEP » utilisés pour chiffrer la clé. La deuxième commande crée un objet Azure Key Vault KeyResolver à l’aide des informations d’identification par défaut Azure. Dans la troisième commande, une nouvelle clé est créée avec le nom défini dans la variable myClientEncryptionKeyName, KeyWrapMetadata a la valeur renvoyée par la première commande et la valeur KeyEncryptionKeyResolver définie sur l’objet KeyResolver obtenu via la deuxième commande.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.