Update-AzureKeyVaultSecret

Referencia

Modul:: AzureRM.KeyVault

Frissítések kulcstartóban lévő titkos kulcs attribútumait.

Figyelmeztetés

Az AzureRM PowerShell-modul 2024. február 29-én hivatalosan elavult. Javasoljuk a felhasználóknak, hogy migráljanak az AzureRM-ből az Az PowerShell-modulba a folyamatos támogatás és frissítések biztosítása érdekében.

Bár az AzureRM-modul továbbra is működik, a továbbiakban nem tart fenn vagy nem támogatott, így a folyamatos használatot a felhasználó saját belátása szerint és kockázatára teheti. Az Az modulra való áttéréshez tekintse meg a migrálási erőforrásainkat.

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

Az Update-AzureKeyVaultSecret parancsmag frissíti a kulcstartóban lévő titkos kulcs szerkeszthető attribútumait.

Példák

1. példa: Titkos kód attribútumainak módosítása

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

Az első négy parancs definiálja a lejárati dátum, a NotBefore dátum, a címkék és a környezet típusa attribútumait, és változókban tárolja az attribútumokat. Az utolsó parancs módosítja a HR nevű titkos kulcs attribútumait a ContosoVault nevű kulcstartóban a tárolt változók használatával.

2. példa: Titkos kód címkéinek és tartalomtípusának törlése

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

Ez a parancs törli a contoso nevű kulcstartóban a HR nevű titkos kód megadott verziójának címkéit és tartalomtípusát.

3. példa: A titkos kódok jelenlegi verziójának letiltása, amelynek a neve it-val kezdődik

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

Az első parancs a Contoso sztringértéket tárolja a $Vault változóban. A második parancs az it sztringértéket a $Prefix változóban tárolja. A harmadik parancs a Get-AzureKeyVaultSecret parancsmaggal szerzi be a titkos kulcsokat a megadott kulcstartóban, majd átadja ezeket a titkos kulcsokat a Where-Object parancsmagnak. A Where-Object parancsmag szűri a titkos kódokat az informatikai karakterekkel kezdődő nevekhez. A parancs a szűrőnek megfelelő titkos kulcsokat az Update-AzureKeyVaultSecret parancsmagra irányítja, amely letiltja őket.

4. példa: A ContentType beállítása egy titkos kód összes verziójához

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

Az első három parancs definiálja a VaultName, Name és ContentType paraméterekhez használandó sztringváltozókat. A negyedik parancs a Get-AzureKeyVaultKey parancsmagot használja a megadott kulcsok lekéréséhez, és a kulcsokat az Update-AzureKeyVaultSecret parancsmagba irányítja, hogy a tartalomtípust XML-re állítsa.

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

Típus:	SwitchParameter
Aliasok:	cf
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-ContentType

Titkos kód tartalomtípusa. Ha nincs megadva, a titkos kód tartalomtípusának meglévő értéke változatlan marad. Távolítsa el a meglévő tartalomtípus értékét egy üres sztring megadásával.

Típus:	String
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-DefaultProfile

Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés.

Típus:	IAzureContextContainer
Aliasok:	AzureRmContext, AzureCredential
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-Enable

Ha jelen van, engedélyezze a titkos kulcsot, ha az érték igaz. Tiltsa le a titkos kódot, ha az érték hamis. Ha nincs megadva, a titkos kód engedélyezett/letiltott állapotának meglévő értéke változatlan marad.

Típus:	Nullable<T>[Boolean]
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-Expires

Egy titkos kód lejárati ideje UTC-ben. Ha nincs megadva, a titkos kód lejárati idejének meglévő értéke változatlan marad.

Típus:	Nullable<T>[DateTime]
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-InputObject

Titkos objektum

Típus:	PSKeyVaultSecretIdentityItem
Position:	0
Alapértelmezett érték:	None
Kötelező:	True
Folyamatbemenet elfogadása:	True
Helyettesítő karakterek elfogadása:	False

-Name

Titkos név. A parancsmag egy titkos kód teljes tartománynevét hozza létre a tároló nevéből, a jelenleg kijelölt környezetből és titkos névből.

Típus:	String
Aliasok:	SecretName
Position:	1
Alapértelmezett érték:	None
Kötelező:	True
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-NotBefore

Az a UTC idő, amely előtt a titkos kód nem használható. Ha nincs megadva, a titkos kód NotBefore attribútumának meglévő értéke változatlan marad.

Típus:	Nullable<T>[DateTime]
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-PassThru

A parancsmag alapértelmezés szerint nem ad vissza objektumot. Ha ez a kapcsoló meg van adva, adja vissza a Titkos kulcs objektumot.

Típus:	SwitchParameter
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-Tag

Titkos címkéket ábrázoló kivonatoló. Ha nincs megadva, a titkos kód meglévő címkéi változatlanok maradnak. Egy üres hashtable megadásával távolítsa el a címkét.

Típus:	Hashtable
Aliasok:	Tags
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-VaultName

Tároló neve. A parancsmag a tároló teljes tartománynevét a név és az aktuálisan kiválasztott környezet alapján hozza létre.

Típus:	String
Position:	0
Alapértelmezett érték:	None
Kötelező:	True
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-Version

Titkos verzió. A parancsmag egy titkos kód teljes tartománynevét hozza létre a tároló nevéből, a jelenleg kijelölt környezetből, a titkos névből és a titkos verzióból.

Típus:	String
Aliasok:	SecretVersion
Position:	2
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut.

Típus:	SwitchParameter
Aliasok:	wi
Position:	Named
Alapértelmezett érték:	None
Kötelező:	False
Folyamatbemenet elfogadása:	False
Helyettesítő karakterek elfogadása:	False

Bevitelek

PSKeyVaultSecretIdentityItem

Paraméterek: InputObject (ByValue)

Kimenetek

PSKeyVaultSecret

Megosztás a következőn keresztül: