Update-AzKeyVaultKey

Sintaxis

Default (valor predeterminado)

Update-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [[-Version] <String>]
    [-Enable <Boolean>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-KeyOps <String[]>]
    [-Tag <Hashtable>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmInteractive

Update-AzKeyVaultKey
    [-Name] <String>
    [[-Version] <String>]
    -HsmName <String>
    [-Enable <Boolean>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-KeyOps <String[]>]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-Tag <Hashtable>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject

Update-AzKeyVaultKey
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [[-Version] <String>]
    [-Enable <Boolean>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-KeyOps <String[]>]
    [-Tag <Hashtable>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Ejemplos

Ejemplo 1: Modificar una clave para habilitarla y establecer la fecha de expiración y las etiquetas

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags           : Name        Value
                 Severity    high
                 Accounting  true

Ejemplo 2: Modificación de una clave para eliminar todas las etiquetas

Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags           :

Parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades de parámetro

Conjuntos de parámetros

-DefaultProfile

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

Propiedades de parámetro

Conjuntos de parámetros

-Enable

El valor true habilita la clave y un valor de false deshabilita la clave. Si no se especifica, el estado habilitado o deshabilitado existente permanece sin cambios.

Propiedades de parámetro

Conjuntos de parámetros

-Expires

Hora de expiración de una clave en hora UTC. Si no se especifica, la hora de expiración existente de la clave permanece sin cambios. Tenga en cuenta que las expiraciones se omiten para la clave de intercambio de claves usada en el proceso BYOK.

Propiedades de parámetro

Conjuntos de parámetros

-HsmName

Nombre de HSM. El cmdlet construye el FQDN de un HSM administrado en función del nombre y del entorno seleccionado actualmente.

Propiedades de parámetro

Conjuntos de parámetros

-Immutable

Establece la directiva de versión como estado inmutable. Una vez marcado como inmutable, esta marca no se puede restablecer y la directiva no se puede cambiar en ninguna circunstancia.

Propiedades de parámetro

Conjuntos de parámetros

-InputObject

Key (objeto)

Propiedades de parámetro

Conjuntos de parámetros

-KeyOps

Las operaciones que se pueden realizar con la clave. Si no se especifica, las operaciones de clave existentes de la clave permanecen sin cambios.

Propiedades de parámetro

Conjuntos de parámetros

-Name

Nombre de clave. El cmdlet construye el FQDN de una clave a partir del nombre del almacén, el entorno y el nombre de clave seleccionados actualmente.

Propiedades de parámetro

Conjuntos de parámetros

-NotBefore

Hora UTC antes de la cual no se puede usar la clave. Si no se especifica, el atributo NotBefore existente de la clave permanece sin cambios.

Propiedades de parámetro

Conjuntos de parámetros

-PassThru

El cmdlet no devuelve un objeto de forma predeterminada. Si se especifica este modificador, devuelve el objeto de agrupación de claves actualizado.

Propiedades de parámetro

Conjuntos de parámetros

-ReleasePolicyPath

Ruta de acceso a un archivo que contiene la definición de directiva JSON. Reglas de directiva en las que se puede exportar una clave.

Propiedades de parámetro

Conjuntos de parámetros

-Tag

Una tabla hash representa etiquetas de clave. Si no se especifica, las etiquetas existentes de la clave permanecen sin cambios.

Propiedades de parámetro

Conjuntos de parámetros

-VaultName

Nombre del almacén. El cmdlet construye el FQDN de un almacén en función del nombre y del entorno seleccionado actualmente.

Propiedades de parámetro

Conjuntos de parámetros

-Version

Versión de la clave. El cmdlet construye el FQDN de una clave a partir del nombre del almacén, el entorno seleccionado actualmente, el nombre de clave y la versión de la clave.

Propiedades de parámetro

Conjuntos de parámetros

-WhatIf

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

Propiedades de parámetro

Conjuntos de parámetros

CommonParameters

Entradas

PSKeyVaultKeyIdentityItem

Salidas

PSKeyVaultKey