Update-AzureKeyVaultKey

Referencia

Modul:: AzureRM.KeyVault

Frissítések kulcs attribútumait egy kulcstartóban.

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-AzureKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Az Update-AzureKeyVaultKey parancsmag frissíti egy kulcs szerkeszthető attribútumait egy kulcstartóban.

Példák

1. példa: Kulcs módosítása annak engedélyezéséhez, valamint a lejárati dátum és a címkék beállítása

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
PS C:\> Update-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags           : Name        Value
                 Severity    high
                 Accounting  true

Az első parancs létrehoz egy DateTime-objektumot a Get-Date parancsmaggal. Ez az objektum két évet határoz meg a jövőben. A parancs a dátumot a $Expires változóban tárolja. További információkért írja be a következőt Get-Help Get-Date: A második parancs létrehoz egy változót a nagy súlyosságú és a könyvelési címkeértékek tárolásához. Az utolsó parancs módosít egy ITSoftware nevű kulcsot. A parancs engedélyezi a kulcsot, beállítja a lejárati idejét a $Expires tárolt időre, és beállítja a $Tags tárolt címkéket.

2. példa: Kulcs módosítása az összes címke törléséhez

PS C:\> Update-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags           :

Ez a parancs törli az ITSoftware nevű kulcs egy adott verziójához tartozó összes címkét.

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

-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

Az igaz érték lehetővé teszi a kulcsot, a hamis érték pedig letiltja a kulcsot. Ha nincs megadva, a meglévő engedélyezett/letiltott állapot 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

A kulcs lejárati ideje UTC-ben. Ha nincs megadva, a kulcs érvényessége 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

Kulcsobjektum

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

-KeyOps

A kulccsal végrehajtható műveletek. Ha nincs megadva, a kulcs meglévő kulcsműveletei változatlanok maradnak.

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

-Name

Kulcsnév. A parancsmag egy kulcs teljes tartománynevét hozza létre a tároló nevéből, az aktuálisan kiválasztott környezetből és kulcsnévből.

Típus:	String
Aliasok:	KeyName
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 kulcs nem használható. Ha nincs megadva, a kulcs meglévő NotBefore attribútuma 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ó van megadva, a frissített kulcsköteg objektumot adja vissza.

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

-Tag

A kivonatoló a kulcscímkéket jelöli. Ha nincs megadva, a kulcs meglévő címkéi változatlanok maradnak.

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

Kulcsverzió. A parancsmag egy kulcs teljes tartománynevét hozza létre a tároló nevéből, a jelenleg kijelölt környezetből, a kulcsnévből és a kulcsverzióból.

Típus:	String
Aliasok:	KeyVersion
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

PSKeyVaultKeyIdentityItem

Paraméterek: InputObject (ByValue)

Kimenetek

PSKeyVaultKey

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