Set-AzKeyVaultSecret

  • Referencia
Modul:
Az.KeyVault

Titkos kulcsot hoz létre vagy frissít egy kulcstartóban.

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

A Set-AzKeyVaultSecret parancsmag létrehoz vagy frissít egy titkos kulcsot az Azure Key Vault egyik kulcstartójában. Ha a titkos kód nem létezik, ez a parancsmag hozza létre. Ha a titkos kód már létezik, ez a parancsmag létrehozza a titkos kód új verzióját.

Példák

1. példa: Titkos kód értékének módosítása alapértelmezett attribútumokkal

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

Az első parancs a ConvertTo-SecureString parancsmaggal biztonságos sztringgé alakítja át a sztringet, majd a sztringet a $Secret változóban tárolja. További információkért írja be a következőt Get-Help ConvertTo-SecureString: A második parancs módosítja az ITSecret nevű titkos kód értékét a Contoso nevű kulcstartóban. A titkos kulcs értéke a $Secret tárolt érték lesz.

2. példa: Titkos kód értékének módosítása egyéni attribútumokkal

$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

Az első parancs a ConvertTo-SecureString parancsmaggal biztonságos sztringgé alakítja át a sztringet, majd a sztringet a $Secret változóban tárolja. További információkért írja be a következőt Get-Help ConvertTo-SecureString: A következő parancsok egyéni attribútumokat határoznak meg a lejárati dátumhoz, a címkékhez és a környezet típusához, és változókban tárolják az attribútumokat. Az utolsó parancs módosítja az ITSecret nevű titkos kód értékeit a Contoso nevű kulcstartóban a korábban változóként megadott értékek használatával.

3. példa: Titkos kód létrehozása az Azure Key Vaultban a Microsoft.PowerShell.SecretManagement modul Set-Secret parancsával

# 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

Ez a példa egy Azure Key Vaultban test-kv elnevezett secureSecret titkos kulcsot állít be a modul Microsoft.PowerShell.SecretManagementparancsai Set-Secret alapján.

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

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

-ContentType

Egy titkos kód tartalomtípusát adja meg. A meglévő tartalomtípus törléséhez adjon meg egy üres sztringet.

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

-DefaultProfile

Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés

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

-Disable

Azt jelzi, hogy ez a parancsmag letilt egy titkos kulcsot.

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

-Expires

A parancsmag által frissített titkos kód lejárati idejét adja meg DateTime-objektumként. Ez a paraméter az egyezményes világidőt (UTC) használja. DateTime-objektum beszerzéséhez használja a Get-Date parancsmagot. További információkért írja be a következőt Get-Help Get-Date:

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

-InputObject

Titkos objektum

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

-Name

Megadja a módosítani kívánt titkos kód nevét. Ez a parancsmag egy titkos kód teljes tartománynevét (FQDN) hozza létre a paraméter által megadott név, a kulcstartó neve és az aktuális környezet alapján.

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

-NotBefore

Dátum/idő objektumként azt az időt adja meg, amely előtt a titkos kód nem használható. Ez a paraméter UTC-t használ. DateTime-objektum beszerzéséhez használja a Get-Date parancsmagot.

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

-SecretValue

A titkos kulcs értékét Adja meg SecureString objektumként. SecureString-objektum beszerzéséhez használja a ConvertTo-SecureString parancsmagot. További információkért írja be a következőt Get-Help ConvertTo-SecureString:

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

-Tag

Kulcs-érték párok kivonattábla formájában. Például: @{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

Annak a kulcstartónak a nevét adja meg, amelyhez ez a titkos kulcs tartozik. Ez a parancsmag egy kulcstartó teljes tartománynevét hozza létre a paraméter által megadott név és az aktuális környezet alapján.

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

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut.

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

Bevitelek

PSKeyVaultSecretIdentityItem

Kimenetek

PSKeyVaultSecret