Update-AzureKeyVaultSecret

Module:

AzureRM.KeyVault

Werkt kenmerken van een geheim in een sleutelkluis bij.

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-AzureKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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

Description

De cmdlet Update-AzureKeyVaultSecret werkt bewerkbare kenmerken van een geheim in een sleutelkluis bij.

Voorbeelden

Voorbeeld 1: De kenmerken van een geheim wijzigen

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Nbf = (Get-Date).ToUniversalTime()
PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
PS C:\> $ContentType= 'xml'
PS C:\> Update-AzureKeyVaultSecret -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

Met de eerste vier opdrachten worden kenmerken gedefinieerd voor de vervaldatum, de Datum notBefore-datum, tags en het contexttype, en worden de kenmerken opgeslagen in variabelen. Met de laatste opdracht worden de kenmerken voor het geheim met de naam HR in de sleutelkluis met de naam ContosoVault gewijzigd met behulp van de opgeslagen variabelen.

Voorbeeld 2: de tags en het inhoudstype voor een geheim verwijderen

PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag -@{}

Met deze opdracht verwijdert u de tags en het inhoudstype voor de opgegeven versie van het geheim met de naam HR in de sleutelkluis met de naam Contoso.

Voorbeeld 3: De huidige versie van geheimen uitschakelen waarvan de naam begint met IT

PS C:\> $Vault = 'ContosoVault'
PS C:\> $Prefix = 'IT'
PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzureKeyVaultSecret -Enable $False

Met de eerste opdracht wordt de tekenreekswaarde Contoso opgeslagen in de variabele $Vault. Met de tweede opdracht wordt de tekenreekswaarde IT opgeslagen in de $Prefix variabele. De derde opdracht maakt gebruik van de cmdlet Get-AzureKeyVaultSecret om de geheimen op te halen in de opgegeven sleutelkluis en geeft deze geheimen vervolgens door aan de cmdlet Where-Object . De cmdlet Where-Object filtert de geheimen voor namen die beginnen met de tekens IT. Met de opdracht worden de geheimen uitgevoerd die overeenkomen met het filter met de cmdlet Update-AzureKeyVaultSecret, waardoor ze worden uitgeschakeld.

Voorbeeld 4: Het ContentType instellen voor alle versies van een geheim

PS C:\> $VaultName = 'ContosoVault'
PS C:\> $Name = 'HR'
PS C:\> $ContentType = 'xml'
PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzureKeyVaultSecret -ContentType $ContentType

De eerste drie opdrachten definiëren tekenreeksvariabelen die moeten worden gebruikt voor de parameters VaultName, Name en ContentType . De vierde opdracht maakt gebruik van de cmdlet Get-AzureKeyVaultKey om de opgegeven sleutels op te halen en pijpt de sleutels naar de cmdlet Update-AzureKeyVaultSecret om het inhoudstype in te stellen op XML.

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

-ContentType

Het inhoudstype van het geheim. Als dit niet is opgegeven, blijft de bestaande waarde van het inhoudstype van het geheim ongewijzigd. Verwijder de bestaande waarde van het inhoudstype door een lege tekenreeks op te geven.

Type:	String
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

Als deze aanwezig is, schakelt u een geheim in als de waarde waar is. Schakel een geheim uit als de waarde onwaar is. Als dit niet is opgegeven, blijft de bestaande waarde van de ingeschakelde/uitgeschakelde status van het geheim 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 geheim in UTC-tijd. Als dit niet is opgegeven, blijft de bestaande waarde van de verlooptijd van het geheim ongewijzigd.

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

-InputObject

Geheim object

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

-Name

Geheime naam. Cmdlet bouwt de FQDN van een geheim uit kluisnaam, momenteel geselecteerde omgeving en geheime naam.

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

-NotBefore

De UTC-tijd voordat het geheim niet kan worden gebruikt. Als dit niet is opgegeven, blijft de bestaande waarde van het kenmerk NotBefore van het geheim 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, retourneert u geheimobject.

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

-Tag

Een hashtabel die geheime tags vertegenwoordigt. Als dit niet is opgegeven, blijven de bestaande tags van het geheim ongewijzigd. Verwijder een tag door een lege hashtabel op te geven.

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

Geheime versie. Cmdlet bouwt de FQDN van een geheim van kluisnaam, momenteel geselecteerde omgeving, geheime naam en geheime versie.

Type:	String
Aliases:	SecretVersion
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

PSKeyVaultSecretIdentityItem

Parameters: InputObject (ByValue)

Uitvoerwaarden

PSKeyVaultSecret