Update-AzKeyVaultSecret

Riferimento

Modulo:: Az.KeyVault

Aggiornamenti attributi di un segreto in un insieme di credenziali delle chiavi.

Sintassi

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

Descrizione

Il cmdlet Update-AzKeyVaultSecret aggiorna gli attributi modificabili di un segreto in un insieme di credenziali delle chiavi.

Esempio

Esempio 1: Modificare gli attributi di un segreto

$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

I primi quattro comandi definiscono gli attributi per la data di scadenza, la data NotBefore, i tag e il tipo di contesto e archivia gli attributi nelle variabili. Il comando finale modifica gli attributi per il segreto denominato HR nell'insieme di credenziali delle chiavi denominato ContosoVault, usando le variabili archiviate.

Esempio 2: Eliminare i tag e il tipo di contenuto per un segreto

Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}

Questo comando elimina i tag e il tipo di contenuto per la versione specificata del segreto denominato HR nell'insieme di credenziali delle chiavi denominato Contoso.

Esempio 3: Disabilitare la versione corrente dei segreti il cui nome inizia con l'IT

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False

Il primo comando archivia il valore stringa Contoso nella variabile $Vault. Il secondo comando archivia il valore stringa IT nella variabile $Prefix. Il terzo comando usa il cmdlet Get-AzKeyVaultSecret per ottenere i segreti nell'insieme di credenziali delle chiavi specificato e quindi passa tali segreti al cmdlet Where-Object . Il cmdlet Where-Object filtra i segreti per i nomi che iniziano con i caratteri IT. Il comando invia tramite pipe i segreti che corrispondono al filtro al cmdlet Update-AzKeyVaultSecret, che li disabilita.

Esempio 4: Impostare ContentType per tutte le versioni di un segreto

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType

I primi tre comandi definiscono le variabili stringa da usare per i parametri VaultName, Name e ContentType . Il quarto comando usa il cmdlet Get-AzKeyVaultKey per ottenere le chiavi specificate e invia tramite pipe le chiavi al cmdlet Update-AzKeyVaultSecret per impostare il tipo di contenuto su XML.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-ContentType

Tipo di contenuto del segreto. Se non specificato, il valore esistente del tipo di contenuto del segreto rimane invariato. Rimuovere il valore del tipo di contenuto esistente specificando una stringa vuota.

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

-DefaultProfile

Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Enable

Se presente, abilitare un segreto se il valore è true. Disabilitare un segreto se il valore è false. Se non specificato, il valore esistente dello stato abilitato/disabilitato del segreto rimane invariato.

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

-Expires

Ora di scadenza di un segreto nell'ora UTC. Se non specificato, il valore esistente dell'ora di scadenza del segreto rimane invariato.

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

-InputObject

Oggetto segreto

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Nome segreto. Il cmdlet costruisce il nome FQDN di un segreto dal nome dell'insieme di credenziali, l'ambiente e il nome del segreto attualmente selezionati.

Type:	String
Aliases:	SecretName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NotBefore

Ora UTC prima del quale non è possibile usare il segreto. Se non specificato, il valore esistente dell'attributo NotBefore del segreto rimane invariato.

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

-PassThru

Il cmdlet non restituisce l'oggetto per impostazione predefinita. Se si specifica questa opzione, restituire l'oggetto Secret.

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

-Tag

Tabella hash che rappresenta i tag dei segreti. Se non specificato, i tag esistenti del segreto rimangono invariati. Rimuovere un tag specificando una tabella Hash vuota.

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

Nome dell'insieme di credenziali. Il cmdlet costruisce il nome di dominio completo di un insieme di credenziali in base al nome e all'ambiente attualmente selezionato.

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

-Version

Versione privata. Il cmdlet costruisce l'FQDN di un segreto dal nome dell'insieme di credenziali, l'ambiente attualmente selezionato, il nome del segreto e la versione del segreto.

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

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

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

Input

PSKeyVaultSecretIdentityItem

Output

PSKeyVaultSecret