Delen via

Update-AzCosmosDbClientEncryptionKey

  • Referentie
Module:
Az.CosmosDB

Hiermee wordt de CosmosDB-clientversleutelingssleutel bijgewerkt. Voert een patchbewerking aan de clientzijde uit door de bestaande clientversleutelingssleutel te lezen.

Syntaxis

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>
      [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
      -SqlDatabaseObject <PSSqlDatabaseGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDbClientEncryptionKey
      -KeyWrapMetadata <PSSqlKeyWrapMetadata>
      [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
      -InputObject <PSSqlClientEncryptionKeyGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

De Update-AzCosmosDbClientEncryptionKey werkt de CosmosDb-clientversleutelingssleutel bij. Voert een patchbewerking aan de clientzijde uit door de bestaande CosmosDB-clientversleutelingssleutel te lezen.

Voorbeelden

Voorbeeld 1

$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

In dit voorbeeld ziet u hoe een sleutel wordt bijgewerkt. Als KeyEncryptionKeyResolver niet wordt doorgegeven aan Azure Key Vault KeyResolver, wordt standaard gebruikt. Met de eerste opdracht maakt u een KeyWrapMetadata-object met de naam myKekV2 van het type AZURE_KEY_VAULT met de waarde ingesteld op sleutel-id https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 en algoritmetype 'RSA-OAEP' dat wordt gebruikt om de sleutel te versleutelen. In de tweede opdracht wordt een sleutel met de naam die is ingesteld in de variabele myClientEncryptionKeyName bijgewerkt met KeyWrapMetadata ingesteld op waarde die wordt geretourneerd door de eerste opdracht.

Voorbeeld 2

$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

In dit voorbeeld ziet u hoe een sleutel wordt bijgewerkt en hoe KeyEncryptionKeyResolver kan worden doorgegeven als parameter. Met de eerste opdracht maakt u een KeyWrapMetadata-object met de naam myKekV2 van het type AZURE_KEY_VAULT met de waarde ingesteld op sleutel-id https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 en algoritmetype 'RSA-OAEP' dat wordt gebruikt om de sleutel te versleutelen. Met de tweede opdracht maakt u een Azure Key Vault KeyResolver-object met behulp van de standaardreferenties van Azure. In de derde opdracht wordt een sleutel met de naam die is ingesteld in de variabele myClientEncryptionKeyName bijgewerkt met KeyWrapMetadata ingesteld op waarde die wordt geretourneerd door de eerste opdracht en keyEncryptionKeyResolver-waarde ingesteld op KeyResolver-object dat is verkregen via de tweede opdracht.

Voorbeeld 3

$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

In dit voorbeeld ziet u hoe een sleutel wordt bijgewerkt met behulp van een InputObject dat wordt verkregen door de sleutel te lezen die moet worden bijgewerkt. Met de eerste opdracht maakt u een KeyWrapMetadata-object met de naam myKekV2 van het type AZURE_KEY_VAULT met de waarde ingesteld op sleutel-id https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 en algoritmetype 'RSA-OAEP' dat wordt gebruikt om de sleutel te versleutelen. In de tweede opdracht wordt de sleutel gelezen die moet worden bijgewerkt. Met de derde opdracht wordt de sleutel bijgewerkt die eerder in de tweede opdracht is gelezen. Het object dat in de tweede opdracht wordt gelezen, wordt doorgegeven als het InputObject, samen met de bijgewerkte KeyWrapMetadata die in de eerste opdracht is verkregen.

Parameters

-AccountName

Naam van het Cosmos DB-databaseaccount.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-DatabaseName

Databasenaam.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-InputObject

Client Encryption Key-object.

Type:PSSqlClientEncryptionKeyGetResults
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-KeyEncryptionKeyResolver

Interface IKeyEncryptionKeyResolver van het type Azure.Core.Cryptography.IKeyEncryptionKeyResolver

Type:IKeyEncryptionKeyResolver
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-KeyWrapMetadata

KeyWrapMetaData-object van het type Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata.

Type:PSSqlKeyWrapMetadata
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Name

Naam van clientversleutelingssleutel.

Type:String
Aliassen:ClientEncryptionKeyName
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ResourceGroupName

Naam van resourcegroep.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-SqlDatabaseObject

Sql Database-object.

Type:PSSqlDatabaseGetResults
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

Byte[]

PSSqlKeyWrapMetadata

Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider

PSSqlDatabaseGetResults

PSSqlClientEncryptionKeyGetResults

Uitvoerwaarden

PSSqlClientEncryptionKeyGetResults

ResourceNotFoundException