Update-AzCosmosDbClientEncryptionKey

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

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

Update-AzCosmosDbClientEncryptionKey
    -KeyWrapMetadata <PSSqlKeyWrapMetadata>
    -InputObject <PSSqlClientEncryptionKeyGetResults>
    [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update-AzCosmosDbClientEncryptionKey met à jour la clé de chiffrement du client CosmosDb. Effectue une opération de correctif côté client en lisant la clé de chiffrement du client CosmosDB existante.

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

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 clé est mise à jour. 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 myKekV2 de type AZURE_KEY_VAULT avec la valeur définie sur l’ID de https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 clé et le type d’algorithme « RSA-OAEP » utilisé pour chiffrer la clé. Dans la deuxième commande, une clé portant le nom défini dans la variable myClientEncryptionKeyName est mise à jour avec KeyWrapMetadata définie sur la valeur retournée par la première commande.

$updatedKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV2","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP"))
$azureKeyVaultKeyResolver = [Azure.Security.KeyVault.Keys.Cryptography.KeyResolver]::new([Azure.Identity.DefaultAzureCredential]::new())
Update-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -KeyWrapMetadata $updatedKeyWrapMetadataObject -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 clé est mise à jour et comment KeyEncryptionKeyResolver peut être passé en tant que paramètre. La première commande crée un objet KeyWrapMetadata avec le nom myKekV2 de type AZURE_KEY_VAULT avec la valeur définie sur l’ID de https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 clé et le type d’algorithme « RSA-OAEP » utilisé 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 clé portant le nom défini dans la variable myClientEncryptionKeyName est mise à jour avec KeyWrapMetadata définie sur la valeur retournée par la première commande et la valeur KeyEncryptionKeyResolver définie sur l’objet KeyResolver obtenu via la deuxième commande.

$updatedKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV2","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP"))
$keyToUpdate = Get-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -ClientEncryptionKeyName myClientEncryptionKeyName
Update-AzCosmosDbClientEncryptionKey -InputObject $keyToUpdate -KeyWrapMetadata $updatedKeyWrapMetadataObject -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 clé est mise à jour à l’aide d’un InputObject obtenu en lisant la clé à mettre à jour. La première commande crée un objet KeyWrapMetadata avec le nom myKekV2 de type AZURE_KEY_VAULT avec la valeur définie sur l’ID de https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 clé et le type d’algorithme « RSA-OAEP » utilisé pour chiffrer la clé. Dans la deuxième commande, la clé doit être mise à jour. La troisième commande met à jour la clé qui a été lue précédemment dans la deuxième commande. L’objet lu dans la deuxième commande est passé en tant qu’InputObject, ainsi que la mise à jour de KeyWrapMetadata obtenue dans la première 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.