Set-AzKeyVaultSecret

  • Referens
Modul:
Az.KeyVault

Skapar eller uppdaterar en hemlighet i ett nyckelvalv.

Syntax

Set-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <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

Cmdleten Set-AzKeyVaultSecret skapar eller uppdaterar en hemlighet i ett nyckelvalv i Azure Key Vault. Om hemligheten inte finns skapar den här cmdleten den. Om hemligheten redan finns skapar den här cmdleten en ny version av hemligheten.

Exempel

Exempel 1: Ändra värdet för en hemlighet med hjälp av standardattribut

$Secret = ConvertTo-SecureString -String 'Password' -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         :

Det första kommandot konverterar en sträng till en säker sträng med hjälp av cmdleten ConvertTo-SecureString och lagrar sedan strängen i variabeln $Secret. Om du vill ha mer information skriver du Get-Help ConvertTo-SecureString. Det andra kommandot ändrar värdet för hemligheten med namnet ITSecret i nyckelvalvet med namnet Contoso. Det hemliga värdet blir värdet som lagras i $Secret.

Exempel 2: Ändra värdet för en hemlighet med hjälp av anpassade attribut

$Secret = ConvertTo-SecureString -String 'Password' -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

Det första kommandot konverterar en sträng till en säker sträng med hjälp av cmdleten ConvertTo-SecureString och lagrar sedan strängen i variabeln $Secret. Om du vill ha mer information skriver du Get-Help ConvertTo-SecureString. Nästa kommandon definierar anpassade attribut för förfallodatum, taggar och kontexttyp och lagrar attributen i variabler. Det sista kommandot ändrar värdena för hemligheten med namnet ITSecret i nyckelvalvet med namnet Contoso, med hjälp av de värden som angavs tidigare som variabler.

Exempel 3: Skapa en hemlighet i Azure Key Vault med kommandot Set-Secret i modulen 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 "Password" -AsPlainText -Force
Set-Secret -Name secureSecret -SecureStringSecret $secure -Vault AzKeyVault

None

I det här exemplet anges en hemlighet med namnet secureSecret i Azure Key Vault test-kv efter kommando Set-Secret i modulen Microsoft.PowerShell.SecretManagement.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentType

Anger innehållstypen för en hemlighet. Om du vill ta bort den befintliga innehållstypen anger du en tom sträng.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Disable

Anger att den här cmdleten inaktiverar en hemlighet.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expires

Anger förfallotiden, som ett DateTime-objekt , för hemligheten som denna cmdlet uppdaterar. Den här parametern använder COORDINATED Universal Time (UTC). Om du vill hämta ett DateTime-objekt använder du cmdleten Get-Date . Om du vill ha mer information skriver du Get-Help Get-Date.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Hemligt objekt

Type:PSKeyVaultSecretIdentityItem
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Anger namnet på en hemlighet som ska ändras. Den här cmdleten konstruerar det fullständigt kvalificerade domännamnet (FQDN) för en hemlighet baserat på det namn som den här parametern anger, namnet på nyckelvalvet och din aktuella miljö.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NotBefore

Anger tiden, som ett DateTime-objekt , innan hemligheten inte kan användas. Den här parametern använder UTC. Om du vill hämta ett DateTime-objekt använder du cmdleten Get-Date .

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SecretValue

Anger värdet för hemligheten som ett SecureString-objekt . Om du vill hämta ett SecureString-objekt använder du cmdleten ConvertTo-SecureString . Om du vill ha mer information skriver du Get-Help ConvertTo-SecureString.

Type:SecureString
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Nyckel/värde-par i form av en hash-tabell. Exempel: @{key0="value0"; key1=$null; key2="value2"}

Type:Hashtable
Aliases:Tags
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

Anger namnet på nyckelvalvet som hemligheten tillhör. Den här cmdleten konstruerar FQDN för ett nyckelvalv baserat på namnet som den här parametern anger och din aktuella miljö.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Indata

PSKeyVaultSecretIdentityItem

Utdata

PSKeyVaultSecret