Update-AzureKeyVaultSecret

Módulo:

AzureRM.KeyVault

Actualiza los atributos de un secreto 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-AzureKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

El cmdlet Update-AzureKeyVaultSecret actualiza los atributos editables de un secreto en un almacén de claves.

Ejemplos

Ejemplo 1: Modificación de los atributos de un secreto

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Nbf = (Get-Date).ToUniversalTime()
PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
PS C:\> $ContentType= 'xml'
PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru

Vault Name   : ContosoVault
Name         : HR
Version      : d476edfcd3544017a03bc49c1f3abec0
Id           : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0
Enabled      : True
Expires      : 5/25/2020 8:01:58 PM
Not Before   : 5/25/2018 8:02:02 PM
Created      : 4/11/2018 11:45:06 PM
Updated      : 5/25/2018 8:02:45 PM
Content Type : xml
Tags         : Name      Value
               Severity  medium
               HR        true

Los cuatro primeros comandos definen atributos para la fecha de expiración, la fecha NotBefore, las etiquetas y el tipo de contexto, y almacenan los atributos en variables. El comando final modifica los atributos del secreto denominado HR en el almacén de claves denominado ContosoVault, mediante las variables almacenadas.

Ejemplo 2: Eliminar las etiquetas y el tipo de contenido de un secreto

PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag -@{}

Este comando elimina las etiquetas y el tipo de contenido de la versión especificada del secreto denominado HR en el almacén de claves denominado Contoso.

Ejemplo 3: Deshabilitar la versión actual de secretos cuyo nombre comienza con TI

PS C:\> $Vault = 'ContosoVault'
PS C:\> $Prefix = 'IT'
PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzureKeyVaultSecret -Enable $False

El primer comando almacena el valor de cadena Contoso en la variable $Vault. El segundo comando almacena el valor de cadena IT en la variable $Prefix. El tercer comando usa el cmdlet Get-AzureKeyVaultSecret para obtener los secretos en el almacén de claves especificado y, a continuación, pasa esos secretos al cmdlet Where-Object . El cmdlet Where-Object filtra los secretos de los nombres que comienzan por los caracteres de TI. El comando canaliza los secretos que coinciden con el filtro con el cmdlet Update-AzureKeyVaultSecret, que los deshabilita.

Ejemplo 4: Establecer contentType para todas las versiones de un secreto

PS C:\> $VaultName = 'ContosoVault'
PS C:\> $Name = 'HR'
PS C:\> $ContentType = 'xml'
PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzureKeyVaultSecret -ContentType $ContentType

Los tres primeros comandos definen variables de cadena que se usarán para los parámetros VaultName, Name y ContentType . El cuarto comando usa el cmdlet Get-AzureKeyVaultKey para obtener las claves especificadas y canaliza las claves al cmdlet Update-AzureKeyVaultSecret para establecer su tipo de contenido en XML.

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

-ContentType

Tipo de contenido del secreto. Si no se especifica, el valor existente del tipo de contenido del secreto permanece sin cambios. Quite el valor de tipo de contenido existente especificando una cadena vacía.

Tipo:	String
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

Si está presente, habilite un secreto si el valor es true. Deshabilite un secreto si el valor es false. Si no se especifica, el valor existente del estado habilitado o deshabilitado del secreto 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 un secreto en hora UTC. Si no se especifica, el valor existente de la hora de expiración del secreto 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

Secret (objeto)

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

-Name

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

Tipo:	String
Alias:	SecretName
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 el secreto. Si no se especifica, el valor existente del atributo NotBefore del secreto 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 el objeto de forma predeterminada. Si se especifica este modificador, devuelva el objeto Secret.

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

-Tag

Tabla hash que representa etiquetas secretas. Si no se especifica, las etiquetas existentes del secreto permanecen sin cambios. Quite una etiqueta especificando una tabla Hash vacía.

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 secreta. El cmdlet construye el FQDN de un secreto del nombre del almacén, el entorno seleccionado actualmente, el nombre del secreto y la versión del secreto.

Tipo:	String
Alias:	SecretVersion
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

PSKeyVaultSecretIdentityItem

Parámetros: InputObject (ByValue)

Salidas

PSKeyVaultSecret