Update-AzureKeyVaultSecret

Referens

Modul:: AzureRM.KeyVault

Uppdaterar attribut för en hemlighet i ett nyckelvalv.

Varning

AzureRM PowerShell-modulen är officiellt inaktuell från och med den 29 februari 2024. Användare rekommenderas att migrera från AzureRM till Az PowerShell-modulen för att säkerställa fortsatt support och uppdateringar.

Även om AzureRM-modulen fortfarande kan fungera, underhålls den inte längre eller stöds, vilket gör att användaren kan välja och riskera fortsatt användning. Se våra migreringsresurser för vägledning om övergången till Az-modulen.

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

Cmdleten Update-AzureKeyVaultSecret uppdaterar redigerbara attribut för en hemlighet i ett nyckelvalv.

Exempel

Exempel 1: Ändra attributen för en hemlighet

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

De första fyra kommandona definierar attribut för förfallodatumet, datum, taggar och kontexttyp för NotBefore och lagrar attributen i variabler. Det sista kommandot ändrar attributen för hemligheten med namnet HR i nyckelvalvet med namnet ContosoVault med hjälp av de lagrade variablerna.

Exempel 2: Ta bort taggarna och innehållstypen för en hemlighet

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

Det här kommandot tar bort taggarna och innehållstypen för den angivna versionen av hemligheten med namnet HR i nyckelvalvet med namnet Contoso.

Exempel 3: Inaktivera den aktuella versionen av hemligheter vars namn börjar med IT

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

Det första kommandot lagrar strängvärdet Contoso i variabeln $Vault. Det andra kommandot lagrar strängvärdet IT i variabeln $Prefix. Det tredje kommandot använder cmdleten Get-AzureKeyVaultSecret för att hämta hemligheterna i det angivna nyckelvalvet och skickar sedan dessa hemligheter till cmdleten Where-Object . Cmdleten Where-Object filtrerar hemligheterna efter namn som börjar med tecknen IT. Kommandot dirigerar hemligheterna som matchar filtret till cmdleten Update-AzureKeyVaultSecret, vilket inaktiverar dem.

Exempel 4: Ange ContentType för alla versioner av en hemlighet

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 första tre kommandona definierar strängvariabler som ska användas för parametrarna VaultName, Name och ContentType . Det fjärde kommandot använder cmdleten Get-AzureKeyVaultKey för att hämta de angivna nycklarna och skickar nycklarna till cmdleten Update-AzureKeyVaultSecret för att ange innehållstypen till XML.

Parametrar

-Confirm

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

Typ:	SwitchParameter
Alias:	cf
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-ContentType

Hemlighetens innehållstyp. Om det inte anges förblir det befintliga värdet för hemlighetens innehållstyp oförändrat. Ta bort det befintliga innehållstypsvärdet genom att ange en tom sträng.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-DefaultProfile

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

Typ:	IAzureContextContainer
Alias:	AzureRmContext, AzureCredential
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Enable

Om det finns aktiverar du en hemlighet om värdet är sant. Inaktivera en hemlighet om värdet är falskt. Om det inte anges förblir det befintliga värdet för hemlighetens aktiverade/inaktiverade tillstånd oförändrat.

Typ:	Nullable<T>[Boolean]
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Expires

Förfallotiden för en hemlighet i UTC-tid. Om det inte anges förblir det befintliga värdet för hemlighetens förfallotid oförändrat.

Typ:	Nullable<T>[DateTime]
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-InputObject

Hemligt objekt

Typ:	PSKeyVaultSecretIdentityItem
Position:	0
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-Name

Hemligt namn. Cmdlet konstruerar FQDN för en hemlighet från valvnamnet, som för närvarande är valt miljö och hemligt namn.

Typ:	String
Alias:	SecretName
Position:	1
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-NotBefore

UTC-tiden innan hemligheten inte kan användas. Om det inte anges förblir det befintliga värdet för hemlighetens NotBefore-attribut oförändrat.

Typ:	Nullable<T>[DateTime]
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-PassThru

Cmdlet returnerar inte objekt som standard. Om den här växeln har angetts returnerar du Hemligt objekt.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Tag

En hashtable som representerar hemliga taggar. Om det inte anges förblir de befintliga taggarna för hemligheten oförändrade. Ta bort en tagg genom att ange en tom Hashtable.

Typ:	Hashtable
Alias:	Tags
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-VaultName

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

Typ:	String
Position:	0
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Version

Hemlig version. Cmdlet konstruerar FQDN för en hemlighet från valvnamn, för närvarande vald miljö, hemligt namn och hemlig version.

Typ:	String
Alias:	SecretVersion
Position:	2
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-WhatIf

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

Typ:	SwitchParameter
Alias:	wi
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

Indata

PSKeyVaultSecretIdentityItem

Parametrar: InputObject (ByValue)

Utdata

PSKeyVaultSecret

Dela via