Sdílet prostřednictvím

Set-AzKeyVaultSecret

  • Reference
Modul:
Az.KeyVault

Vytvoří nebo aktualizuje tajný klíč v trezoru klíčů.

Syntaxe

Set-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzKeyVaultSecret
   [-Id] <String>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzKeyVaultSecret
   [-InputObject] <PSKeyVaultSecretIdentityItem>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Rutina Set-AzKeyVaultSecret vytvoří nebo aktualizuje tajný kód v trezoru klíčů ve službě Azure Key Vault. Pokud tajný klíč neexistuje, tato rutina ho vytvoří. Pokud tajný klíč již existuje, tato rutina vytvoří novou verzi tohoto tajného kódu.

Příklady

Příklad 1: Úprava hodnoty tajného kódu pomocí výchozích atributů

$Secret = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret

Vault Name   : Contoso
Name         : ITSecret
Version      : 8b5c0cb0326e4350bd78200fac932b51
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51
Enabled      : True
Expires      :
Not Before   :
Created      : 5/25/2018 6:39:30 PM
Updated      : 5/25/2018 6:39:30 PM
Content Type :
Tags         :

První příkaz převede řetězec na zabezpečený řetězec pomocí rutiny ConvertTo-SecureString a pak tento řetězec uloží do proměnné $Secret. Další informace potřebujete zadáním Get-Help ConvertTo-SecureString. Druhý příkaz upraví hodnotu tajného klíče s názvem ITSecret v trezoru klíčů s názvem Contoso. Hodnota tajného kódu se stane hodnotou uloženou v $Secret.

Příklad 2: Úprava hodnoty tajného kódu pomocí vlastních atributů

$Secret = ConvertTo-SecureString -String "****" -AsPlainText -Force
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$NBF =(Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'IT' = 'true'}
$ContentType = 'txt'
Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -Expires $Expires -NotBefore $NBF -ContentType $ContentType -Disable -Tags $Tags

Vault Name   : Contoso
Name         : ITSecret
Version      : a2c150be3ea24dd6b8286986e6364851
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/a2c150be3ea24dd6b8286986e6364851
Enabled      : False
Expires      : 5/25/2020 6:40:00 PM
Not Before   : 5/25/2018 6:40:05 PM
Created      : 5/25/2018 6:41:22 PM
Updated      : 5/25/2018 6:41:22 PM
Content Type : txt
Tags         : Name      Value
               Severity  medium
               IT        true

První příkaz převede řetězec na zabezpečený řetězec pomocí rutiny ConvertTo-SecureString a pak tento řetězec uloží do proměnné $Secret. Další informace potřebujete zadáním Get-Help ConvertTo-SecureString. Další příkazy definují vlastní atributy pro datum vypršení platnosti, značky a typ kontextu a ukládají atributy do proměnných. Poslední příkaz upraví hodnoty tajného klíče s názvem ITSecret v trezoru klíčů s názvem Contoso pomocí dříve zadaných hodnot jako proměnných.

Příklad 3: Úprava hodnoty tajného klíče pomocí výchozích atributů (pomocí identifikátoru URI)

$Secret = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/ITSecret' -SecretValue $Secret

Vault Name   : Contoso
Name         : ITSecret
Version      : 8b5c0cb0326e4350bd78200fac932b51
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51
Enabled      : True
Expires      :
Not Before   :
Created      : 5/25/2018 6:39:30 PM
Updated      : 5/25/2018 6:39:30 PM
Content Type :
Tags         :

Tento příkaz nastaví nebo aktualizuje hodnotu tajného kódu s názvem secret1 ve službě Key Vault s názvem Contoso pomocí identifikátoru URI tajného kódu.

Příklad 4: Vytvoření tajného kódu ve službě Azure Key Vault příkazem Set-Secret v modulu Microsoft.PowerShell.SecretManagement

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Name secureSecret -SecureStringSecret $secure -Vault AzKeyVault

None

Tento příklad nastaví tajný kód s názvem secureSecret ve službě Azure Key Vault test-kv příkazem Set-Secret v modulu Microsoft.PowerShell.SecretManagement.

Parametry

-Confirm

Před spuštěním rutiny vás vyzve 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

Určuje typ obsahu tajného kódu. Pokud chcete odstranit existující typ obsahu, zadejte prázdný řetězec.

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:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Disable

Označuje, že tato rutina zakáže tajný kód.

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

-Expires

Určuje dobu vypršení platnosti objektu DateTime tajný klíč, který tato rutina aktualizuje. Tento parametr používá standard UTC (Coordinated Universal Time). K získání objektu DateTime použijte rutinu Get-Date. Další informace potřebujete zadáním Get-Help Get-Date.

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

-Id

Identifikátor URI tajného klíče služby KeyVault. Ujistěte se, že se řídí formátem: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Typ:String
Aliasy:SecretId
Position:0
Default value:None
Vyžadováno:True
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

Určuje název tajného kódu, který chcete upravit. Tato rutina vytvoří plně kvalifikovaný název domény (FQDN) tajného kódu na základě názvu, který tento parametr určuje, název trezoru klíčů a aktuální prostředí.

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

Určuje čas, jako DateTime objekt, před kterým nelze tajný kód použít. Tento parametr používá STANDARD UTC. K získání objektu DateTime použijte rutinu Get-Date.

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

-SecretValue

Určuje hodnotu tajného kódu jako objekt SecureString. K získání objektu SecureString použijte rutinu ConvertTo-SecureString. Další informace potřebujete zadáním Get-Help ConvertTo-SecureString.

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

-Tag

Páry klíč-hodnota ve formě tabulky hash. Příklad: @{key0="value0"; key1=$null; key2="value2"}

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

Určuje název trezoru klíčů, do kterého tento tajný klíč patří. Tato rutina vytvoří plně kvalifikovaný název domény trezoru klíčů na základě názvu, který tento parametr určuje a vaše aktuální 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

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

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

Výstupy

PSKeyVaultSecret