Update-AzureKeyVaultKey

Referencia

Módulo:: AzureRM.KeyVault

Actualiza los atributos de una clave en un almacén de claves.

Advertencia

El módulo AzureRM PowerShell ha quedado oficialmente obsoleto a partir del 29 de febrero de 2024. Se recomienda a los usuarios migrar de AzureRM al módulo Az PowerShell para seguir recibiendo soporte técnico y actualizaciones.

Aunque el módulo AzureRM puede seguir funcionando, ya no recibirá mantenimiento ni soporte técnico, lo que significa que su uso continuado queda a discreción y riesgo del usuario. Consulte nuestros recursos de migración para ver una guía sobre la transición al módulo Az.

Sintaxis

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

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

Description

El cmdlet Update-AzureKeyVaultKey actualiza los atributos editables de una clave en un almacén de claves.

Ejemplos

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

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
PS C:\> Update-AzureKeyVaultKey -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

El primer comando crea un objeto DateTime mediante el cmdlet Get-Date . Ese objeto especifica un tiempo de dos años en el futuro. El comando almacena esa fecha en la variable $Expires. Para obtener más información, escriba Get-Help Get-Date. El segundo comando crea una variable para almacenar valores de etiqueta de gravedad alta y Contabilidad. El comando final modifica una clave denominada ITSoftware. El comando habilita la clave, establece su tiempo de expiración en la hora almacenada en $Expires y establece las etiquetas almacenadas en $Tags.

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

PS C:\> Update-AzureKeyVaultKey -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           :

Este comando elimina todas las etiquetas de una versión específica de una clave denominada ITSoftware.

Parámetros

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:	SwitchParameter
Alias:	cf
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-DefaultProfile

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

Tipo:	IAzureContextContainer
Alias:	AzureRmContext, AzureCredential
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	Nullable<T>[Boolean]
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	Nullable<T>[DateTime]
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-InputObject

Objeto de clave

Tipo:	PSKeyVaultKeyIdentityItem
Posición:	0
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

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

Tipo:	String[]
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Alias:	KeyName
Posición:	1
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	Nullable<T>[DateTime]
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-PassThru

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

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Tag

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

Tipo:	Hashtable
Alias:	Tags
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-VaultName

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

Tipo:	String
Posición:	0
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Alias:	KeyVersion
Posición:	2
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-WhatIf

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

Tipo:	SwitchParameter
Alias:	wi
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

Entradas

PSKeyVaultKeyIdentityItem

Parámetros: InputObject (ByValue)

Salidas

PSKeyVaultKey

Compartir a través de