Update-AzCosmosDbClientEncryptionKey

Reference

Modul:: Az.CosmosDB

Aktualizuje šifrovací klíč klienta cosmos DB. Provede operaci opravy na straně klienta čtením existujícího šifrovacího klíče klienta.

Syntaxe

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

Update-AzCosmosDbClientEncryptionKey aktualizuje šifrovací klíč klienta cosmosDB. Provede operaci opravy na straně klienta čtením existujícího šifrovacího klíče klienta CosmosDB.

Příklady

Příklad 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

Tento příklad ukazuje, jak se klíč aktualizuje. Pokud keyEncryptionKeyResolver nepředá službu Azure Key Vault KeyResolver, použije se ve výchozím nastavení. První příkaz vytvoří objekt KeyWrapMetadata s názvem myKekV2 typu AZURE_KEY_VAULT s hodnotou nastavenou na ID klíče https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 a algoritmus typu RSA-OAEP použitý k šifrování klíče. Ve druhém příkazu se klíč s názvem nastaveným v proměnné myClientEncryptionKeyName aktualizuje pomocí KeyWrapMetadata nastavenou na hodnotu vrácenou prvním příkazem.

Příklad 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

Tento příklad ukazuje, jak se klíč aktualizuje a jak lze keyEncryptionKeyResolver předat jako parametr. První příkaz vytvoří objekt KeyWrapMetadata s názvem myKekV2 typu AZURE_KEY_VAULT s hodnotou nastavenou na ID klíče https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 a algoritmus typu RSA-OAEP použitý k šifrování klíče. Druhý příkaz vytvoří objekt KeyResolver služby Azure Key Vault pomocí výchozích přihlašovacích údajů Azure. Ve třetím příkazu se klíč s názvem nastaveným v proměnné myClientEncryptionKeyName aktualizuje s hodnotou KeyWrapMetadata nastavenou na hodnotu vrácenou prvním příkazem a hodnotou KeyEncryptionKeyResolver nastavenou na objekt KeyResolver získaný pomocí druhého příkazu.

Příklad 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

Tento příklad ukazuje, jak se klíč aktualizuje pomocí objektu InputObject, který se získá čtením klíče, který se má aktualizovat. První příkaz vytvoří objekt KeyWrapMetadata s názvem myKekV2 typu AZURE_KEY_VAULT s hodnotou nastavenou na ID klíče https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 a algoritmus typu RSA-OAEP použitý k šifrování klíče. Ve druhém příkazu přečte klíč, který se má aktualizovat. Třetí příkaz aktualizuje klíč, který jste si přečetli dříve v druhém příkazu. Objekt přečtený v druhém příkazu se předává jako InputObject spolu s aktualizovaným KeyWrapMetadata získaným v prvním příkazu.

Parametry

-AccountName

Název účtu databáze Cosmos DB.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DatabaseName

Název databáze.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:	IAzureContextContainer
Aliasy:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-InputObject

Objekt šifrovacího klíče klienta.

Typ:	PSSqlClientEncryptionKeyGetResults
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-KeyEncryptionKeyResolver

IKeyEncryptionKeyResolver – rozhraní typu Azure.Core.Cryptography.IKeyEncryptionKeyResolver

Typ:	IKeyEncryptionKeyResolver
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-KeyWrapMetadata

KeyWrapMetaData – objekt typu Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata.

Typ:	PSSqlKeyWrapMetadata
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-Name

Název šifrovacího klíče klienta.

Typ:	String
Aliasy:	ClientEncryptionKeyName
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ResourceGroupName

Název skupiny prostředků

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-SqlDatabaseObject

Objekt sql Database.

Typ:	PSSqlDatabaseGetResults
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

Vstupy

Byte[]

PSSqlKeyWrapMetadata

Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider

PSSqlDatabaseGetResults

PSSqlClientEncryptionKeyGetResults

Výstupy

PSSqlClientEncryptionKeyGetResults

ResourceNotFoundException

Sdílet prostřednictvím

Update-AzCosmosDbClientEncryptionKey

Syntaxe

Description

Příklady

Příklad 1

Příklad 2

Příklad 3

Parametry

-AccountName

-Confirm

-DatabaseName

-DefaultProfile

-InputObject

-KeyEncryptionKeyResolver

-KeyWrapMetadata

-Name

-ResourceGroupName

-SqlDatabaseObject

-WhatIf

Vstupy

Výstupy

Další materiály

Sdílet prostřednictvím

Update-AzCosmosDbClientEncryptionKey

Syntaxe

Description

Příklady

Příklad 1

Příklad 2

Příklad 3

Parametry

-AccountName

-Confirm

-DatabaseName

-DefaultProfile

-InputObject

-KeyEncryptionKeyResolver

-KeyWrapMetadata

-Name

-ResourceGroupName

-SqlDatabaseObject

-WhatIf

Vstupy

Výstupy

Související odkazy

Další materiály