Update-AzCosmosDbClientEncryptionKey

  • Başvuru
Modül:
Az.CosmosDB

CosmosDB İstemci Şifreleme Anahtarını güncelleştirir. Mevcut İstemci Şifreleme Anahtarını okuyarak bir istemci tarafı düzeltme eki işlemi gerçekleştirir.

Sözdizimi

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, CosmosDb İstemci Şifreleme Anahtarını güncelleştirir. Mevcut CosmosDB İstemci Şifreleme Anahtarını okuyarak bir istemci tarafı düzeltme eki işlemi gerçekleştirir.

Örnekler

Örnek 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

Bu örnekte anahtarın nasıl güncelleştirilmiş olduğu gösterilmektedir. KeyEncryptionKeyResolver geçirilmezse Azure Key Vault KeyResolver varsayılan olarak kullanılır. İlk komut, anahtar kimliği https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 olarak ayarlanmış AZURE_KEY_VAULT türünde myKekV2 adlı bir KeyWrapMetadata nesnesi oluşturur ve anahtarı şifrelemek için kullanılan algoritma türü "RSA-OAEP" olur. İkinci komutta myClientEncryptionKeyName değişkeninde ayarlanan ada sahip bir anahtar, KeyWrapMetadata ilk komut tarafından döndürülen değere ayarlanmış olarak güncelleştirilir.

Örnek 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

Bu örnekte bir anahtarın nasıl güncelleştirildiği ve KeyEncryptionKeyResolver'ın parametre olarak nasıl geçirilebileceği gösterilmektedir. İlk komut, anahtar kimliği https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 olarak ayarlanmış AZURE_KEY_VAULT türünde myKekV2 adlı bir KeyWrapMetadata nesnesi oluşturur ve anahtarı şifrelemek için kullanılan algoritma türü "RSA-OAEP" olur. İkinci komut, Azure Varsayılan kimlik bilgilerini kullanarak bir Azure Key Vault KeyResolver nesnesi oluşturur. Üçüncü komutta myClientEncryptionKeyName değişkeninde ayarlanan adlı bir anahtar, keyWrapMetadata değeri ilk komut tarafından döndürülen değere, KeyEncryptionKeyResolver değeri ise ikinci komutla alınan KeyResolver nesnesine ayarlanmış olarak güncelleştirilir.

Örnek 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

Bu örnekte, güncelleştirilmiş olması gereken anahtar okunarak elde edilen bir InputObject kullanılarak anahtarın nasıl güncelleştirildiği gösterilir. İlk komut, anahtar kimliği https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 olarak ayarlanmış AZURE_KEY_VAULT türünde myKekV2 adlı bir KeyWrapMetadata nesnesi oluşturur ve anahtarı şifrelemek için kullanılan algoritma türü "RSA-OAEP" olur. İkinci komutta güncelleştirilecek olan anahtarı okur. Üçüncü komut, ikinci komutta daha önce okunan anahtarı güncelleştirir. İkinci komutta okunan nesne, ilk komutta elde edilen güncelleştirilmiş KeyWrapMetadata ile birlikte InputObject olarak geçirilir.

Parametreler

-AccountName

Cosmos DB veritabanı hesabının adı.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Confirm

Cmdlet'i çalıştırmadan önce sizden onay ister.

Tür:SwitchParameter
Diğer adlar:cf
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-DatabaseName

Veritabanı adı.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-InputObject

İstemci Şifreleme Anahtarı nesnesi.

Tür:PSSqlClientEncryptionKeyGetResults
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-KeyEncryptionKeyResolver

Azure.Core.Cryptography.IKeyEncryptionKeyResolver türünde IKeyEncryptionKeyResolver arabirimi

Tür:IKeyEncryptionKeyResolver
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-KeyWrapMetadata

Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata türünde KeyWrapMetaData Nesnesi.

Tür:PSSqlKeyWrapMetadata
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Name

İstemci Şifreleme Anahtarı adı.

Tür:String
Diğer adlar:ClientEncryptionKeyName
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ResourceGroupName

Kaynak grubunun adı.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-SqlDatabaseObject

Sql Veritabanı nesnesi.

Tür:PSSqlDatabaseGetResults
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-WhatIf

Cmdlet çalıştırılıyorsa ne olacağını gösterir. Cmdlet çalıştırılmaz.

Tür:SwitchParameter
Diğer adlar:wi
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

Girişler

Byte[]

PSSqlKeyWrapMetadata

Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider

PSSqlDatabaseGetResults

PSSqlClientEncryptionKeyGetResults

Çıkışlar

PSSqlClientEncryptionKeyGetResults

ResourceNotFoundException