Update-AzKeyVaultKey

  • Riferimento
Modulo:
Az.KeyVault

Aggiorna gli attributi di una chiave in un insieme di credenziali delle chiavi.

Sintassi

Update-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Immutable]
      [-ReleasePolicyPath <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Descrizione

Il cmdlet Update-AzKeyVaultKey aggiorna gli attributi modificabili di una chiave in un insieme di credenziali delle chiavi.

Esempio

Esempio 1: Modificare una chiave per abilitarla e impostare la data di scadenza e i tag

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

Il primo comando crea un oggetto DateTime usando il cmdlet Get-Date . L'oggetto specifica un periodo di due anni in futuro. Il comando archivia tale data nella variabile $Expires. Per ulteriori informazioni, digitare Get-Help Get-Date. Il secondo comando crea una variabile per archiviare i valori dei tag di gravità elevata e Accounting. Il comando finale modifica una chiave denominata ITSoftware. Il comando abilita la chiave, imposta l'ora di scadenza sull'ora archiviata in $Expires e imposta i tag archiviati in $Tags.

Esempio 2: Modificare una chiave per eliminare tutti i tag

Update-AzKeyVaultKey -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           :

Questo comando elimina tutti i tag per una versione specifica di una chiave denominata ITSoftware.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Enable

Il valore true abilita la chiave e il valore false disabilita la chiave. Se non specificato, lo stato abilitato/disabilitato esistente rimane invariato.

Tipo:Nullable<T>[Boolean]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Expires

Ora di scadenza di una chiave nell'ora UTC. Se non specificato, l'ora di scadenza esistente della chiave rimane invariata. Si noti che la scadenza viene ignorata per la chiave di scambio delle chiavi usata nel processo BYOK.

Tipo:Nullable<T>[DateTime]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-HsmName

Nome HSM. Il cmdlet costruisce il nome di dominio completo di un modulo di protezione hardware gestito in base al nome e all'ambiente attualmente selezionato.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Immutable

Imposta il criterio di rilascio come stato non modificabile. Una volta contrassegnato come non modificabile, questo flag non può essere reimpostato e i criteri non possono essere modificati in alcuna circostanza.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-InputObject

Oggetto Key

Tipo:PSKeyVaultKeyIdentityItem
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-KeyOps

Operazioni che possono essere eseguite con la chiave. Se non specificato, le operazioni chiave esistenti della chiave rimangono invariate.

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Name

Nome chiave. Il cmdlet costruisce il nome FQDN di una chiave dal nome dell'insieme di credenziali, l'ambiente e il nome della chiave attualmente selezionati.

Tipo:String
Alias:KeyName
Posizione:1
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-NotBefore

Ora UTC prima della quale non è possibile usare la chiave. Se non specificato, l'attributo NotBefore esistente della chiave rimane invariato.

Tipo:Nullable<T>[DateTime]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-PassThru

Il cmdlet non restituisce un oggetto per impostazione predefinita. Se questa opzione viene specificata, restituisce l'oggetto bundle di chiavi aggiornato.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-ReleasePolicyPath

Percorso di un file contenente la definizione dei criteri JSON. Regole dei criteri in base alle quali è possibile esportare una chiave.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Tag

Una tabella hash rappresenta i tag chiave. Se non specificato, i tag esistenti della chiave rimangono invariati.

Tipo:Hashtable
Alias:Tags
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly: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.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Version

Versione chiave. Il cmdlet costruisce il nome FQDN di una chiave dal nome dell'insieme di credenziali, l'ambiente attualmente selezionato, il nome della chiave e la versione della chiave.

Tipo:String
Alias:KeyVersion
Posizione:2
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-WhatIf

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

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

PSKeyVaultKeyIdentityItem

Output

PSKeyVaultKey