New-AzCosmosDbClientEncryptionKey

Módulo:

Az.CosmosDB

Cria uma nova chave de criptografia de cliente do CosmosDB.

Sintaxe

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

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

Description

O New-AzCosmosDbClientEncryptionKey cria uma nova chave de criptografia de cliente do CosmosDB.

Exemplos

Exemplo 1

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

Name     : myContainerName
Id       : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource

Este exemplo mostra como uma nova chave é criada. Se KeyEncryptionKeyResolver não for passado, o KeyResolver do Azure Key Vault será usado por padrão. O primeiro comando cria um objeto KeyWrapMetadata com o nome myKekV1 do tipo AZURE_KEY_VAULT com o valor definido como id de chave https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 e o tipo de algoritmo "RSA-OAEP" usado para criptografar a chave. No segundo comando, uma nova chave é criada com o nome definido na variável myClientEncryptionKeyName e com KeyWrapMetadata definido como valor retornado pelo primeiro comando.

Exemplo 2

$myKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV1","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP"))
$azureKeyVaultKeyResolver = [Azure.Security.KeyVault.Keys.Cryptography.KeyResolver]::new([Azure.Identity.DefaultAzureCredential]::new())
New-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -EncryptionAlgorithmName "AEAD_AES_256_CBC_HMAC_SHA256" -KeyWrapMetadata $myKeyWrapMetadataObject -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

Este exemplo mostra como uma nova chave é criada e como KeyEncryptionKeyResolver pode ser passado como um parâmetro. O primeiro comando cria um objeto KeyWrapMetadata com o nome myKekV1 do tipo AZURE_KEY_VAULT com o valor definido como id de chave https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 e o tipo de algoritmo "RSA-OAEP" usado para criptografar a chave. O segundo comando cria um objeto KeyResolver do Azure Key Vault usando as credenciais padrão do Azure. No terceiro comando, uma nova chave é criada com o nome definido na variável myClientEncryptionKeyName, KeyWrapMetadata definido como valor retornado pelo primeiro comando e o valor KeyEncryptionKeyResolver definido como objeto KeyResolver obtido por meio do segundo comando.

Parâmetros

-AccountName

Nome da conta de banco de dados do Cosmos DB.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Confirm

Solicita a confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-DatabaseName

Nome do banco de dados.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-EncryptionAlgorithmName

Nome do Algoritmo de Criptografia do Cliente.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-KeyEncryptionKeyResolver

Interface IKeyEncryptionKeyResolver do tipo Azure.Core.Cryptography.IKeyEncryptionKeyResolver

Tipo:	IKeyEncryptionKeyResolver
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-KeyWrapMetadata

Objeto KeyWrapMetaData do tipo Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata.

Tipo:	PSSqlKeyWrapMetadata
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Name

Nome da chave de criptografia do cliente.

Tipo:	String
Aliases:	ClientEncryptionKeyName
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ResourceGroupName

Nome do grupo de recursos.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SqlDatabaseObject

Objeto do Banco de Dados Sql.

Tipo:	PSSqlDatabaseGetResults
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

PSSqlKeyWrapMetadata

Byte[]

Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider

PSSqlDatabaseGetResults

Saídas

PSSqlClientEncryptionKeyGetResults

ConflictingResourceException

Links Relacionados

• Get-AzCosmosDbClientEncryptionKey
• Update-AzCosmosDbClientEncryptionKey