Delen via

Set-AzKeyVaultSecret

  • Referentie
Module:
Az.KeyVault

Hiermee maakt of werkt u een geheim in een sleutelkluis bij.

Syntaxis

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

De Set-AzKeyVaultSecret cmdlet maakt of werkt een geheim in een sleutelkluis in Azure Key Vault. Als het geheim niet bestaat, maakt deze cmdlet het. Als het geheim al bestaat, maakt deze cmdlet een nieuwe versie van dat geheim.

Voorbeelden

Voorbeeld 1: De waarde van een geheim wijzigen met behulp van standaardkenmerken

$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         :

Met de eerste opdracht wordt een tekenreeks geconverteerd naar een beveiligde tekenreeks met behulp van de cmdlet ConvertTo-SecureString en wordt die tekenreeks vervolgens opgeslagen in de $Secret variabele. Typ Get-Help ConvertTo-SecureStringvoor meer informatie. Met de tweede opdracht wijzigt u de waarde van het geheim met de naam ITSecret in de sleutelkluis met de naam Contoso. De geheime waarde wordt de waarde die is opgeslagen in $Secret.

Voorbeeld 2: de waarde van een geheim wijzigen met behulp van aangepaste kenmerken

$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

Met de eerste opdracht wordt een tekenreeks geconverteerd naar een beveiligde tekenreeks met behulp van de cmdlet ConvertTo-SecureString en wordt die tekenreeks vervolgens opgeslagen in de $Secret variabele. Typ Get-Help ConvertTo-SecureStringvoor meer informatie. Met de volgende opdrachten worden aangepaste kenmerken gedefinieerd voor de vervaldatum, tags en contexttype, en worden de kenmerken opgeslagen in variabelen. Met de laatste opdracht worden waarden gewijzigd van het geheim met de naam ITSecret in de sleutelkluis met de naam Contoso, met behulp van de waarden die eerder zijn opgegeven als variabelen.

Voorbeeld 3: De waarde van een geheim wijzigen met behulp van standaardkenmerken (met behulp van 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         :

Met deze opdracht wordt de waarde van het geheim met de naam geheim1 ingesteld of bijgewerkt in de Sleutelkluis met de naam Contoso met behulp van de URI van het geheim.

Voorbeeld 4: Een geheim maken in Azure Key Vault met opdracht Set-Secret in module 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

In dit voorbeeld wordt een geheim ingesteld met de naam secureSecret in Azure Key Vault test-kv op opdracht Set-Secret in module Microsoft.PowerShell.SecretManagement.

Parameters

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ContentType

Hiermee geeft u het inhoudstype van een geheim. Als u het bestaande inhoudstype wilt verwijderen, geeft u een lege tekenreeks op.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Disable

Geeft aan dat met deze cmdlet een geheim wordt uitgeschakeld.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Expires

Hiermee geeft u de verlooptijd, als een DateTime--object, op voor het geheim dat door deze cmdlet wordt bijgewerkt. Deze parameter maakt gebruik van Coordinated Universal Time (UTC). Als u een DateTime--object wilt ophalen, gebruikt u de cmdlet Get-Date. Typ Get-Help Get-Datevoor meer informatie.

Type:DateTime
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Id

De URI van het KeyVault-geheim. Zorg ervoor dat deze de volgende indeling heeft: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Type:String
Aliassen:SecretId
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-InputObject

Geheim object

Type:PSKeyVaultSecretIdentityItem
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Name

Hiermee geeft u de naam van een geheim te wijzigen. Met deze cmdlet wordt de FQDN (Fully Qualified Domain Name) van een geheim samengesteld op basis van de naam die met deze parameter wordt opgegeven, de naam van de sleutelkluis en uw huidige omgeving.

Type:String
Aliassen:SecretName
Position:1
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-NotBefore

Hiermee geeft u de tijd, als een DateTime object, voordat het geheim niet kan worden gebruikt. Deze parameter maakt gebruik van UTC. Als u een DateTime--object wilt ophalen, gebruikt u de cmdlet Get-Date.

Type:DateTime
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-SecretValue

Hiermee geeft u de waarde voor het geheim op als een SecureString-object. Als u een SecureString--object wilt verkrijgen, gebruikt u de cmdlet ConvertTo-SecureString. Typ Get-Help ConvertTo-SecureStringvoor meer informatie.

Type:SecureString
Position:2
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Tag

Sleutel-waardeparen in de vorm van een hash-tabel. Bijvoorbeeld: @{key0="value0"; key1=$null; key2="value2"}

Type:Hashtable
Aliassen:Tags
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-VaultName

Hiermee geeft u de naam van de sleutelkluis waartoe dit geheim behoort. Met deze cmdlet wordt de FQDN van een sleutelkluis samengesteld op basis van de naam die met deze parameter wordt opgegeven en uw huidige omgeving.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

PSKeyVaultSecretIdentityItem

Uitvoerwaarden

PSKeyVaultSecret