New-AzCosmosDbClientEncryptionKey

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>
    -SqlDatabaseObject <PSSqlDatabaseGetResults>
    [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

De New-AzCosmosDbClientEncryptionKey maakt een nieuwe CosmosDB-clientversleutelingssleutel.

$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

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

$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

In dit voorbeeld ziet u hoe een nieuwe sleutel wordt gemaakt en hoe KeyEncryptionKeyResolver kan worden doorgegeven als parameter. Met de eerste opdracht maakt u een KeyWrapMetadata-object met de naam myKekV1 van het type AZURE_KEY_VAULT met de waarde ingesteld op sleutel-id https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 en algoritmetype 'RSA-OAEP' die wordt gebruikt om de sleutel te versleutelen. Met de tweede opdracht maakt u een Azure Key Vault KeyResolver-object met behulp van de Azure Standaardreferenties. In de derde opdracht wordt een nieuwe sleutel gemaakt met de naam die is ingesteld in de variabele myClientEncryptionKeyName, 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.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.