Condividi tramite

Update-AzKeyVaultSecret

Modulo:
Az.KeyVault Module

Aggiorna gli attributi di un segreto in un insieme di credenziali delle chiavi.

Sintassi

Default (Impostazione predefinita) 

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

BySecretUri 

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

InputObject 

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.

Esempio 5: Eliminare i tag e il tipo di contenuto per un segreto (usando Uri)

Update-AzKeyVaultSecret -Id 'https://ContosoVault.vault.azure.net:443/secrets/HR/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.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:Cfr

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Proprietà dei parametri

Tipo:IAzureContextContainer
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:

Nullable<T>[Boolean]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:

Nullable<T>[DateTime]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Id

URI del segreto keyvault. Assicurarsi che il formato sia il seguente: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:SecretId

Set di parametri

BySecretUri
Posizione:0
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InputObject

Oggetto segreto

Proprietà dei parametri

Tipo:PSKeyVaultSecretIdentityItem
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

InputObject
Posizione:0
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:SecretName

Set di parametri

Default
Posizione:1
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:

Nullable<T>[DateTime]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PassThru

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:Hashtable
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:Etichette

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

Default
Posizione:0
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Version

Versione del segreto. 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.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:SecretVersion

Set di parametri

(All)
Posizione:2
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-WhatIf

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:Wi

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

PSKeyVaultSecretIdentityItem

Output

PSKeyVaultSecret