Поделиться через

Update-AzCosmosDbClientEncryptionKey

  • Ссылка
Модуль:
Az.CosmosDB

Обновляет ключ шифрования клиента CosmosDB. Выполняет операцию исправления на стороне клиента, считывая существующий ключ шифрования клиента.

Синтаксис

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>]

Описание

Update-AzCosmosDbClientEncryptionKey обновляет ключ шифрования клиента CosmosDb. Выполняет операцию исправления на стороне клиента, считывая существующий ключ шифрования клиента CosmosDB.

Примеры

Пример 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

В этом примере показано, как обновляется ключ. Если KeyEncryptionKeyResolver не передается Azure KeyResolver KeyResolver по умолчанию. Первая команда создает объект KeyWrapMetadata с именем myKekV2 типа AZURE_KEY_VAULT со значением, заданным для идентификатора ключа https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 и типа алгоритма RSA-OAEP, используемого для шифрования ключа. Во второй команде ключ с именем, заданным в переменной myClientEncryptionKeyName, обновляется с помощью keyWrapMetadata, возвращаемого первой командой.

Пример 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

В этом примере показано, как обновляется ключ и как можно передавать ключ KeyEncryptionKeyResolver в качестве параметра. Первая команда создает объект KeyWrapMetadata с именем myKekV2 типа AZURE_KEY_VAULT со значением, заданным для идентификатора ключа https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 и типа алгоритма RSA-OAEP, используемого для шифрования ключа. Вторая команда создает объект KeyResolver Azure KeyResolver с помощью учетных данных По умолчанию Azure. В третьей команде ключ с именем, заданным в переменной myClientEncryptionKeyName, обновляется с помощью параметра KeyWrapMetadata, возвращаемого первой командой, и значение KeyEncryptionKeyResolver, заданное для объекта KeyResolver, полученного с помощью второй команды.

Пример 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

В этом примере показано, как ключ обновляется с помощью объекта InputObject, полученного путем чтения ключа, который необходимо обновить. Первая команда создает объект KeyWrapMetadata с именем myKekV2 типа AZURE_KEY_VAULT со значением, заданным для идентификатора ключа https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 и типа алгоритма RSA-OAEP, используемого для шифрования ключа. Во второй команде считывается ключ, который необходимо обновить. Третья команда обновляет ключ, который был прочитан ранее во второй команде. Объект, считываемый во второй команде, передается как InputObject вместе с обновленными ключами KeyWrapMetadata, полученными в первой команде.

Параметры

-AccountName

Имя учетной записи базы данных Cosmos DB.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DatabaseName

Имя базы данных.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

Объект ключа шифрования клиента.

Тип:PSSqlClientEncryptionKeyGetResults
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-KeyEncryptionKeyResolver

Интерфейс IKeyEncryptionKeyResolver типа Azure.Core.Cryptography.IKeyEncryptionKeyResolver

Тип:IKeyEncryptionKeyResolver
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-KeyWrapMetadata

Объект KeyWrapMetaData типа Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata.

Тип:PSSqlKeyWrapMetadata
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Name

Имя ключа шифрования клиента.

Тип:String
Aliases:ClientEncryptionKeyName
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ResourceGroupName

Имя группы ресурсов.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-SqlDatabaseObject

Объект Базы данных SQL.

Тип:PSSqlDatabaseGetResults
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

Byte[]

PSSqlKeyWrapMetadata

Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider

PSSqlDatabaseGetResults

PSSqlClientEncryptionKeyGetResults

Выходные данные

PSSqlClientEncryptionKeyGetResults

ResourceNotFoundException