Update-AzKeyVaultSecret

Referentie

Module:: Az.KeyVault

Werkt kenmerken van een geheim in een sleutelkluis bij.

Syntaxis

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

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

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

Description

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

Voorbeelden

Voorbeeld 1: De kenmerken van een geheim wijzigen

$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

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

Update-AzKeyVaultSecret -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

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -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 Get-AzKeyVaultSecret cmdlet om de geheimen op te halen in de opgegeven sleutelkluis en geeft deze geheimen vervolgens door aan de Where-Object cmdlet. De cmdlet Where-Object filtert de geheimen op namen die beginnen met de tekens IT. De opdracht voert de geheimen uit die overeenkomen met het filter op de Update-AzKeyVaultSecret cmdlet, waardoor ze worden uitgeschakeld.

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

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType

De eerste drie opdrachten definiëren tekenreeksvariabelen die moeten worden gebruikt voor de parameters VaultName, Nameen ContentType parameters. Met de vierde opdracht wordt de Get-AzKeyVaultKey-cmdlet gebruikt om de opgegeven sleutels op te halen en worden de sleutels doorgegeven aan de Update-AzKeyVaultSecret-cmdlet om het inhoudstype in te stellen op XML.

Voorbeeld 5: verwijder de tags en het inhoudstype voor een geheim (met behulp van URI)

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

Parameters

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:	SwitchParameter
Aliassen:	cf
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliassen:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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:	Boolean
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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:	DateTime
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Id

De URI van het KeyVault-geheim. Zorg ervoor dat deze de volgende indeling heeft: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Type:	String
Aliassen:	SecretId
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-InputObject

Geheim object

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-Name

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

Type:	String
Aliassen:	SecretName
Position:	1
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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:	DateTime
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-PassThru

Cmdlet retourneert standaard geen object. Als deze schakeloptie is opgegeven, retourneert u geheimobject.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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
Aliassen:	Tags
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Version

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

Type:	String
Aliassen:	SecretVersion
Position:	2
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:	SwitchParameter
Aliassen:	wi
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

Invoerwaarden

PSKeyVaultSecretIdentityItem

Uitvoerwaarden

PSKeyVaultSecret

Delen via