Update-AzureKeyVaultKey

Referentie

Module:: AzureRM.KeyVault

Hiermee worden de kenmerken van een sleutel in een sleutelkluis bijgewerkt.

Waarschuwing

De AzureRM PowerShell-module is vanaf 29 februari 2024 officieel afgeschaft. Gebruikers wordt aangeraden om van AzureRM naar de Az PowerShell-module te migreren om ondersteuning en updates te garanderen.

Hoewel de AzureRM-module nog steeds kan functioneren, wordt deze niet meer onderhouden of ondersteund, waardoor het gebruik naar eigen goeddunken en risico van de gebruiker blijft bestaan. Raadpleeg onze migratiebronnen voor hulp bij de overgang naar de Az-module.

Syntax

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

Update-AzureKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

De cmdlet Update-AzureKeyVaultKey werkt de bewerkbare kenmerken van een sleutel in een sleutelkluis bij.

Voorbeelden

Voorbeeld 1: Een sleutel wijzigen om deze in te schakelen en de vervaldatum en tags instellen

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

Met de eerste opdracht maakt u een DateTime-object met behulp van de cmdlet Get-Date . Dit object specificeert een tijd twee jaar in de toekomst. Met de opdracht wordt die datum opgeslagen in de variabele $Expires. Typ voor meer informatie Get-Help Get-Date. Met de tweede opdracht maakt u een variabele voor het opslaan van tagwaarden met hoge ernst en boekhouding. Met de laatste opdracht wijzigt u een sleutel met de naam ITSoftware. Met de opdracht wordt de sleutel ingeschakeld, wordt de verlooptijd ingesteld op de tijd die is opgeslagen in $Expires en worden de tags ingesteld die zijn opgeslagen in $Tags.

Voorbeeld 2: Een sleutel wijzigen om alle tags te verwijderen

PS C:\> Update-AzureKeyVaultKey -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           :

Met deze opdrachten worden alle tags voor een specifieke versie van een sleutel met de naam ITSoftware verwijderd.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

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

-Enable

Met de waarde waar wordt de sleutel ingeschakeld en wordt de sleutel uitgeschakeld door een waarde onwaar. Als dit niet is opgegeven, blijft de bestaande status ingeschakeld/uitgeschakeld ongewijzigd.

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

-Expires

De verlooptijd van een sleutel in UTC-tijd. Als dit niet is opgegeven, blijft de bestaande verlooptijd van de sleutel ongewijzigd.

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

-InputObject

Sleutelobject

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

-KeyOps

De bewerkingen die met de sleutel kunnen worden uitgevoerd. Indien niet opgegeven, blijven de bestaande sleutelbewerkingen van de sleutel ongewijzigd.

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

-Name

Sleutelnaam. Cmdlet bouwt de FQDN van een sleutel op basis van kluisnaam, momenteel geselecteerde omgeving en sleutelnaam.

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

-NotBefore

De UTC-tijd voordat de sleutel niet kan worden gebruikt. Als dit niet is opgegeven, blijft het bestaande kenmerk NotBefore van de sleutel ongewijzigd.

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

-PassThru

Cmdlet retourneert standaard geen object. Als deze schakeloptie is opgegeven, wordt het bijgewerkte sleutelbundelobject geretourneerd.

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

-Tag

Een hashtabel vertegenwoordigt sleuteltags. Als dit niet is opgegeven, blijven de bestaande tags van de sleutel ongewijzigd.

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

-VaultName

Kluisnaam. Cmdlet bouwt de FQDN van een kluis op basis van de naam en momenteel geselecteerde omgeving.

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

-Version

Sleutelversie. Cmdlet bouwt de FQDN van een sleutel op basis van kluisnaam, momenteel geselecteerde omgeving, sleutelnaam en sleutelversie.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

PSKeyVaultKeyIdentityItem

Parameters: InputObject (ByValue)

Uitvoerwaarden

PSKeyVaultKey