Update-AzKeyVaultKey

  • Reference
Modul:
Az.KeyVault

Aktualizuje atributy klíče v trezoru klíčů.

Syntaxe

Update-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Immutable]
      [-ReleasePolicyPath <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Rutina Update-AzKeyVaultKey aktualizuje upravitelné atributy klíče v trezoru klíčů.

Příklady

Příklad 1: Úprava klíče pro jeho povolení a nastavení data a značek vypršení platnosti

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -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

První příkaz vytvoří objekt DateTime pomocí rutiny Get-Date . Tento objekt určuje čas dva roky v budoucnosti. Příkaz uloží toto datum do proměnné $Expires. Další informace potřebujete zadáním Get-Help Get-Date. Druhý příkaz vytvoří proměnnou pro ukládání hodnot značek s vysokou závažností a účtováním. Poslední příkaz upraví klíč s názvem ITSoftware. Příkaz povolí klíč, nastaví jeho čas vypršení platnosti na čas uložený v $Expires a nastaví značky uložené v $Tags.

Příklad 2: Úprava klíče pro odstranění všech značek

Update-AzKeyVaultKey -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           :

Tyto příkazy odstraní všechny značky pro konkrétní verzi klíče s názvem ITSoftware.

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

-DefaultProfile

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

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

-Enable

Hodnota true povolí klíč a hodnota false klíč zakáže. Pokud není zadaný, stávající povolený/zakázaný stav 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 klíče v čase UTC. Pokud není zadaný, stávající čas vypršení platnosti klíče zůstane beze změny. Všimněte si, že vypršení platnosti je ignorováno pro klíč výměny klíčů používaný v procesu BYOK.

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

-HsmName

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

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

-Immutable

Nastaví zásadu vydané verze jako neměnný stav. Jakmile označíte neměnnou, tento příznak nelze resetovat a zásady nelze za žádných okolností změnit.

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

-InputObject

Objekt klíče

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

-KeyOps

Operace, které je možné provést s klíčem. Pokud není zadáno, stávající operace klíče klíče zůstanou beze změny.

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

-Name

Název klíče. Rutina vytvoří plně kvalifikovaný název domény klíče z názvu trezoru, aktuálně vybrané prostředí a název klíče.

Typ:String
Aliasy:KeyName
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 klíč nedá použít. Pokud není zadaný, stávající atribut NotBefore 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č zadaný, vrátí aktualizovaný objekt sady klíčů.

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

-ReleasePolicyPath

Cesta k souboru obsahujícímu definici zásad JSON. Pravidla zásad, pod kterými je možné klíč exportovat.

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

-Tag

Hashtable představuje klíčové značky. Pokud není zadáno, stávající značky klíče zůstanou beze změny.

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 klíče. Rutina vytvoří plně kvalifikovaný název domény klíče z názvu trezoru, aktuálně vybraného prostředí, názvu klíče a verze klíče.

Typ:String
Aliasy:KeyVersion
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

PSKeyVaultKeyIdentityItem

Výstupy

PSKeyVaultKey