Update-AzureKeyVaultSecret

Odwołanie

Moduł:: AzureRM.KeyVault

Aktualizuje atrybuty wpisu tajnego w magazynie kluczy.

Ostrzeżenie

Moduł AzureRM PowerShell jest oficjalnie przestarzały od 29 lutego 2024 r. Zaleca się migrowanie użytkowników z modułu AzureRM do modułu Az programu PowerShell w celu zapewnienia ciągłej obsługi i aktualizacji.

Mimo że moduł AzureRM może nadal działać, nie jest już utrzymywany ani obsługiwany, umieszczając wszelkie dalsze zastosowania według uznania i ryzyka użytkownika. Zapoznaj się z naszymi zasobami migracji, aby uzyskać wskazówki dotyczące przejścia do modułu Az.

Składnia

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>]

Opis

Polecenie cmdlet Update-AzureKeyVaultSecret aktualizuje edytowalne atrybuty wpisu tajnego w magazynie kluczy.

Przykłady

Przykład 1. Modyfikowanie atrybutów wpisu tajnego

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

Pierwsze cztery polecenia definiują atrybuty daty wygaśnięcia, daty NotBefore, tagów i typu kontekstu oraz przechowują atrybuty w zmiennych. Ostatnie polecenie modyfikuje atrybuty wpisu tajnego o nazwie HR w magazynie kluczy o nazwie ContosoVault przy użyciu przechowywanych zmiennych.

Przykład 2. Usuwanie tagów i typu zawartości dla wpisu tajnego

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

To polecenie usuwa tagi i typ zawartości dla określonej wersji wpisu tajnego o nazwie HR w magazynie kluczy o nazwie Contoso.

Przykład 3. Wyłączanie bieżącej wersji wpisów tajnych, których nazwa zaczyna się od IT

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

Pierwsze polecenie przechowuje wartość ciągu Contoso w zmiennej $Vault. Drugie polecenie przechowuje wartość ciągu IT w zmiennej $Prefix. Trzecie polecenie używa polecenia cmdlet Get-AzureKeyVaultSecret w celu pobrania wpisów tajnych w określonym magazynie kluczy, a następnie przekazuje te wpisy tajne do polecenia cmdlet Where-Object . Polecenie cmdlet Where-Object filtruje wpisy tajne dla nazw rozpoczynających się od znaków IT. Polecenie potokuje wpisy tajne zgodne z filtrem do polecenia cmdlet Update-AzureKeyVaultSecret, które je wyłącza.

Przykład 4. Ustawienie właściwości ContentType dla wszystkich wersji wpisu tajnego

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

Pierwsze trzy polecenia definiują zmienne ciągu do użycia dla parametrów VaultName, Name i ContentType . Czwarte polecenie używa polecenia cmdlet Get-AzureKeyVaultKey w celu pobrania określonych kluczy i potokuje klucze do polecenia cmdlet Update-AzureKeyVaultSecret, aby ustawić typ zawartości na XML.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-ContentType

Typ zawartości wpisu tajnego. Jeśli nie zostanie określona, istniejąca wartość typu zawartości wpisu tajnego pozostanie niezmieniona. Usuń istniejącą wartość typu zawartości, określając pusty ciąg.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:	IAzureContextContainer
Aliasy:	AzureRmContext, AzureCredential
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Enable

Jeśli istnieje, włącz wpis tajny, jeśli wartość ma wartość true. Wyłącz wpis tajny, jeśli wartość ma wartość false. Jeśli nie zostanie określona, istniejąca wartość stanu włączonego/wyłączonego wpisu tajnego pozostaje niezmieniona.

Typ:	Nullable<T>[Boolean]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Expires

Czas wygaśnięcia wpisu tajnego w czasie UTC. Jeśli nie zostanie określona, istniejąca wartość czasu wygaśnięcia wpisu tajnego pozostanie niezmieniona.

Typ:	Nullable<T>[DateTime]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-InputObject

Obiekt wpisu tajnego

Typ:	PSKeyVaultSecretIdentityItem
Position:	0
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Name

Nazwa wpisu tajnego. Polecenie cmdlet tworzy nazwę FQDN wpisu tajnego z nazwy magazynu, obecnie wybranego środowiska i nazwy wpisu tajnego.

Typ:	String
Aliasy:	SecretName
Position:	1
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-NotBefore

Czas UTC, przed którym nie można użyć wpisu tajnego. Jeśli nie zostanie określony, istniejąca wartość atrybutu NotBefore wpisu tajnego pozostaje niezmieniona.

Typ:	Nullable<T>[DateTime]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-PassThru

Polecenie cmdlet nie zwraca obiektu domyślnie. Jeśli ten przełącznik zostanie określony, zwróć obiekt Wpis tajny.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Tag

Tabela skrótów reprezentująca tagi wpisów tajnych. Jeśli nie zostanie określony, istniejące tagi wpisu tajnego pozostaną niezmienione. Usuń tag, określając pustą tabelę skrótu.

Typ:	Hashtable
Aliasy:	Tags
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-VaultName

Nazwa magazynu. Polecenie cmdlet konstruuje nazwę FQDN magazynu na podstawie nazwy i aktualnie wybranego środowiska.

Typ:	String
Position:	0
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Version

Wersja wpisu tajnego. Polecenie cmdlet tworzy nazwę FQDN wpisu tajnego z nazwy magazynu, obecnie wybrane środowisko, nazwę wpisu tajnego i wersję wpisu tajnego.

Typ:	String
Aliasy:	SecretVersion
Position:	2
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

PSKeyVaultSecretIdentityItem

Parametry: InputObject (ByValue)

Dane wyjściowe

PSKeyVaultSecret

Udostępnij za pośrednictwem