Update-AzureKeyVaultSecret

Reference

Modul:: AzureRM.KeyVault

Aktualizuje atributy tajného kódu v trezoru klíčů.

Upozorňující

Modul AzureRM PowerShell je od 29. února 2024 oficiálně zastaralý. Uživatelům se doporučuje migrovat z AzureRM do modulu Az PowerShell, aby se zajistila nepřetržitá podpora a aktualizace.

I když může modul AzureRM stále fungovat, už se neudržuje ani nepodporuje, přičemž jakékoli další použití se bude umisťovat podle vlastního uvážení a rizika uživatele. Pokyny k přechodu na modul Az najdete v našich zdrojích informací o migraci.

Syntaxe

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

Rutina Update-AzureKeyVaultSecret aktualizuje upravitelné atributy tajného kódu v trezoru klíčů.

Příklady

Příklad 1: Úprava atributů tajného kódu

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

První čtyři příkazy definují atributy pro datum vypršení platnosti, datum NotBefore, značky a typ kontextu a ukládají atributy do proměnných. Poslední příkaz upraví atributy tajného kódu s názvem HR v trezoru klíčů s názvem ContosoVault pomocí uložených proměnných.

Příklad 2: Odstranění značek a typu obsahu tajného kódu

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

Tento příkaz odstraní značky a typ obsahu pro zadanou verzi tajného kódu s názvem HR v trezoru klíčů s názvem Contoso.

Příklad 3: Zakázání aktuální verze tajných kódů, jejichž název začíná IT

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

První příkaz uloží řetězcovou hodnotu Contoso do proměnné $Vault. Druhý příkaz uloží řetězcovou hodnotu IT do proměnné $Prefix. Třetí příkaz pomocí rutiny Get-AzureKeyVaultSecret získá tajné kódy v zadaném trezoru klíčů a pak tyto tajné kódy předá rutině Where-Object . Rutina Where-Object filtruje tajné kódy pro názvy, které začínají znaky IT. Příkaz předá tajné kódy, které odpovídají filtru, do rutiny Update-AzureKeyVaultSecret, která je zakáže.

Příklad 4: Nastavení contentType pro všechny verze tajného kódu

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

První tři příkazy definují proměnné řetězce, které se mají použít pro parametry VaultName, Name a ContentType . Čtvrtý příkaz používá rutinu Get-AzureKeyVaultKey k získání zadaných klíčů a předá klíče rutině Update-AzureKeyVaultSecret k nastavení jejich typu obsahu na XML.

Parametry

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ContentType

Typ obsahu tajného kódu. Pokud není zadána, stávající hodnota typu obsahu tajného klíče zůstane beze změny. Odeberte existující hodnotu typu obsahu zadáním prázdného řetězce.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:	IAzureContextContainer
Aliasy:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Enable

Pokud je k dispozici, povolte tajný kód, pokud je hodnota true. Pokud je hodnota false, zakažte tajný kód. Pokud není zadáno, stávající hodnota stavu povoleného nebo zakázaného tajného kódu zůstane beze změny.

Typ:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Expires

Čas vypršení platnosti tajného kódu v čase UTC. Pokud není zadáno, stávající hodnota doby vypršení platnosti tajného kódu zůstane beze změny.

Typ:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-InputObject

Tajný objekt

Typ:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-Name

Název tajného kódu. Rutina vytvoří plně kvalifikovaný název domény tajného kódu z názvu trezoru, aktuálně vybrané prostředí a název tajného kódu.

Typ:	String
Aliasy:	SecretName
Position:	1
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-NotBefore

Čas UTC, před kterým se tajný kód nedá použít. Pokud není zadána, stávající hodnota atributu NotBefore tajného klíče zůstane beze změny.

Typ:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-PassThru

Rutina ve výchozím nastavení nevrací objekt. Pokud je tento přepínač zadán, vraťte tajný objekt.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Tag

Hashtable představující tajné značky. Pokud není zadáno, stávající značky tajného kódu zůstanou beze změny. Odeberte značku zadáním prázdné hashtable.

Typ:	Hashtable
Aliasy:	Tags
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-VaultName

Název trezoru Rutina vytvoří plně kvalifikovaný název domény trezoru na základě názvu a aktuálně vybraného prostředí.

Typ:	String
Position:	0
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Version

Verze tajného kódu. Rutina vytvoří plně kvalifikovaný název domény tajného kódu z názvu trezoru, aktuálně vybrané prostředí, název tajného kódu a verzi tajného kódu.

Typ:	String
Aliasy:	SecretVersion
Position:	2
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

Vstupy

PSKeyVaultSecretIdentityItem

Parametry: InputObject (ByValue)

Výstupy

PSKeyVaultSecret

Sdílet prostřednictvím