Compartir a través de

Update-AzCosmosDbClientEncryptionKey

Módulo:
Az.CosmosDB Module

Actualiza la clave de cifrado de cliente de CosmosDB. Realiza una operación de revisión del lado cliente leyendo la clave de cifrado de cliente existente.

Sintaxis

ByNameParameterSet (valor predeterminado) 

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

ByParentObjectParameterSet 

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

ByObjectParameterSet 

Update-AzCosmosDbClientEncryptionKey
    -KeyWrapMetadata <PSSqlKeyWrapMetadata>
    -InputObject <PSSqlClientEncryptionKeyGetResults>
    [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update-AzCosmosDbClientEncryptionKey actualiza la clave de cifrado de cliente de CosmosDb. Realiza una operación de revisión del lado cliente leyendo la clave de cifrado de cliente de CosmosDB existente.

Ejemplos

Ejemplo 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

En este ejemplo se muestra cómo se actualiza una clave. Si KeyEncryptionKeyResolver no se pasa Key Vault KeyResolver se usa de forma predeterminada. El primer comando crea un objeto KeyWrapMetadata con el nombre myKekV2 de tipo AZURE_KEY_VAULT con el valor establecido en id. https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 de clave y el tipo de algoritmo "RSA-OAEP" usado para cifrar la clave. En el segundo comando, se actualiza una clave con el nombre establecido en la variable myClientEncryptionKeyName con KeyWrapMetadata establecido en el valor devuelto por el primer comando.

Ejemplo 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

En este ejemplo se muestra cómo se actualiza una clave y cómo se puede pasar KeyEncryptionKeyResolver como parámetro. El primer comando crea un objeto KeyWrapMetadata con el nombre myKekV2 de tipo AZURE_KEY_VAULT con el valor establecido en id. https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 de clave y el tipo de algoritmo "RSA-OAEP" usado para cifrar la clave. El segundo comando crea un objeto KeyResolver de Azure Key Vault mediante las credenciales predeterminadas de Azure. En el tercer comando, se actualiza una clave con el nombre establecido en la variable myClientEncryptionKeyName con KeyWrapMetadata establecido en el valor devuelto por el primer comando y el valor KeyEncryptionKeyResolver establecido en el objeto KeyResolver obtenido mediante el segundo comando.

Ejemplo 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

En este ejemplo se muestra cómo se actualiza una clave mediante un InputObject que se obtiene leyendo la clave que se debe actualizar. El primer comando crea un objeto KeyWrapMetadata con el nombre myKekV2 de tipo AZURE_KEY_VAULT con el valor establecido en id. https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 de clave y el tipo de algoritmo "RSA-OAEP" usado para cifrar la clave. En el segundo comando se lee la clave que se va a actualizar. El tercer comando actualiza la clave que se leyó anteriormente en el segundo comando. El objeto leído en el segundo comando se pasa como InputObject junto con keyWrapMetadata actualizado obtenido en el primer comando.

Parámetros

-AccountName

Nombre de la cuenta de base de datos de Cosmos DB.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByNameParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DatabaseName

Nombre de la base de datos.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByNameParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

Propiedades de parámetro

Tipo:IAzureContextContainer
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InputObject

Objeto de clave de cifrado de cliente.

Propiedades de parámetro

Tipo:PSSqlClientEncryptionKeyGetResults
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByObjectParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-KeyEncryptionKeyResolver

Interfaz IKeyEncryptionKeyResolver de tipo Azure.Core.Cryptography.IKeyEncryptionKeyResolver

Propiedades de parámetro

Tipo:IKeyEncryptionKeyResolver
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-KeyWrapMetadata

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

Propiedades de parámetro

Tipo:PSSqlKeyWrapMetadata
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

Nombre de clave de cifrado de cliente.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:ClientEncryptionKeyName

Conjuntos de parámetros

ByNameParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentObjectParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ResourceGroupName

Nombre del grupo de recursos.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByNameParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SqlDatabaseObject

Objeto Sql Database.

Propiedades de parámetro

Tipo:PSSqlDatabaseGetResults
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByParentObjectParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

Byte

PSSqlKeyWrapMetadata

Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider

PSSqlDatabaseGetResults

PSSqlClientEncryptionKeyGetResults

Salidas

PSSqlClientEncryptionKeyGetResults

ResourceNotFoundException