Update-AzKeyVaultSecret
Werkt kenmerken van een geheim in een sleutelkluis bij.
Syntax
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
[-InputObject] <PSKeyVaultSecretIdentityItem>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-ContentType <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Met de cmdlet Update-AzKeyVaultSecret worden bewerkbare kenmerken van een geheim in een sleutelkluis bijgewerkt.
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 cmdlet Get-AzKeyVaultSecret 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 voor de cmdlet Update-AzKeyVaultSecret, 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, Name en ContentType . De vierde opdracht gebruikt de cmdlet Get-AzKeyVaultKey om de opgegeven sleutels op te halen en pijpt de sleutels naar de cmdlet Update-AzKeyVaultSecret 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Geheim object
Type: | PSKeyVaultSecretIdentityItem |
Position: | 0 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | 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 |
standaardwaarde: | None |
Vereist: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |