Update-AzKeyVaultKey

Referens

Modul:: Az.KeyVault

Uppdateringar attributen för en nyckel i ett nyckelvalv.

Syntax

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

Description

Cmdleten Update-AzKeyVaultKey uppdaterar de redigerbara attributen för en nyckel i ett nyckelvalv.

Exempel

Exempel 1: Ändra en nyckel för att aktivera den och ange förfallodatum och taggar

$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

Det första kommandot skapar ett DateTime-objekt med cmdleten Get-Date . Det objektet anger en tid två år i framtiden. Kommandot lagrar det datumet i variabeln $Expires. Om du vill ha mer information skriver du Get-Help Get-Date. Det andra kommandot skapar en variabel för att lagra taggvärden med hög allvarlighetsgrad och redovisning. Det sista kommandot ändrar en nyckel med namnet ITSoftware. Kommandot aktiverar nyckeln, anger förfallotiden till den tid som lagras i $Expires och anger taggarna som lagras i $Tags.

Exempel 2: Ändra en nyckel för att ta bort alla taggar

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           :

Med de här kommandona tas alla taggar bort för en specifik version av en nyckel med namnet ITSoftware.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

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

-Enable

Värdet true aktiverar nyckeln och värdet false inaktiverar nyckeln. Om inget anges förblir det befintliga aktiverade/inaktiverade tillståndet oförändrat.

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

-Expires

Förfallotiden för en nyckel i UTC-tid. Om den inte anges förblir den befintliga förfallotiden för nyckeln oförändrad. Observera att förfallodatum ignoreras för Nyckelutbytesnyckel som används i BYOK-processen.

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

-HsmName

HSM-namn. Cmdleten konstruerar FQDN för en hanterad HSM baserat på namnet och den valda miljön.

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

-Immutable

Anger versionsprincipen som oföränderligt tillstånd. När den har markerats som oföränderlig kan den här flaggan inte återställas och principen kan inte ändras under några omständigheter.

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

-InputObject

Nyckelobjekt

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

-KeyOps

De åtgärder som kan utföras med nyckeln. Om det inte anges förblir de befintliga nyckelåtgärderna för nyckeln oförändrade.

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

-Name

Nyckelnamn. Cmdlet konstruerar FQDN för en nyckel från valvnamnet, för närvarande vald miljö och nyckelnamn.

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

-NotBefore

UTC-tiden innan nyckeln inte kan användas. Om det inte anges förblir det befintliga NotBefore-attributet för nyckeln oförändrat.

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

-PassThru

Cmdlet returnerar inte ett objekt som standard. Om den här växeln har angetts returnerar det uppdaterade nyckelsamlingsobjektet.

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

-ReleasePolicyPath

En sökväg till en fil som innehåller JSON-principdefinition. De principregler som en nyckel kan exporteras under.

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

-Tag

En hashtable representerar nyckeltaggar. Om de inte anges förblir de befintliga taggarna för nyckeln oförändrade.

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

-VaultName

Valvnamn. Cmdleten konstruerar FQDN för ett valv baserat på namnet och den aktuella miljön.

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

-Version

Nyckelversion. Cmdlet konstruerar FQDN för en nyckel från valvnamn, för närvarande vald miljö, nyckelnamn och nyckelversion.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

PSKeyVaultKeyIdentityItem

Utdata

PSKeyVaultKey