Update-AzKeyVaultSecret

Referencia

Módulo:: Az.KeyVault

Novedades atributos de un secreto en un almacén de claves.

Syntax

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

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

Description

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

Ejemplos

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

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Nbf = (Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
$ContentType= 'xml'
Update-AzKeyVaultSecret -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

Update-AzKeyVaultSecret -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

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -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-AzKeyVaultSecret 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-AzKeyVaultSecret, que los deshabilita.

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

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -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-AzKeyVaultKey para obtener las claves especificadas y canaliza las claves al cmdlet Update-AzKeyVaultSecret para establecer su tipo de contenido en XML.

Parámetros

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Secret (objeto)

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

Type:	String
Aliases:	SecretName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

El cmdlet no devuelve el objeto de forma predeterminada. Si se especifica este modificador, devuelva el objeto Secret.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Aliases:	SecretVersion
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

PSKeyVaultSecretIdentityItem

Salidas

PSKeyVaultSecret