Update-AzKeyVaultSecret
Aktualizace atributy tajného klíče v trezoru klíčů.
Syntax
Update-AzKeyVaultSecret
[-VaultName] <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-ContentType <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzKeyVaultSecret
[-InputObject] <PSKeyVaultSecretIdentityItem>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-ContentType <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina Update-AzKeyVaultSecret aktualizuje upravitelné atributy tajného kódu v trezoru klíčů.
Příklady
Příklad 1: Úprava atributů tajného kódu
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Nbf = (Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
$ContentType= 'xml'
Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru
Vault Name : ContosoVault
Name : HR
Version : d476edfcd3544017a03bc49c1f3abec0
Id : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0
Enabled : True
Expires : 5/25/2020 8:01:58 PM
Not Before : 5/25/2018 8:02:02 PM
Created : 4/11/2018 11:45:06 PM
Updated : 5/25/2018 8:02:45 PM
Content Type : xml
Tags : Name Value
Severity medium
HR true
První čtyři příkazy definují atributy pro datum vypršení platnosti, datum NotBefore, značky a typ kontextu a ukládají atributy do proměnných. Poslední příkaz upraví atributy tajného kódu s názvem HR v trezoru klíčů s názvem ContosoVault pomocí uložených proměnných.
Příklad 2: Odstranění značek a typu obsahu tajného kódu
Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}
Tento příkaz odstraní značky a typ obsahu pro zadanou verzi tajného kódu s názvem HR v trezoru klíčů s názvem Contoso.
Příklad 3: Zakázání aktuální verze tajných kódů, jejichž název začíná IT
$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False
První příkaz uloží řetězcovou hodnotu Contoso do proměnné $Vault. Druhý příkaz uloží řetězcovou hodnotu IT do proměnné $Prefix. Třetí příkaz pomocí rutiny Get-AzKeyVaultSecret získá tajné kódy v zadaném trezoru klíčů a pak tyto tajné kódy předá rutině Where-Object . Rutina Where-Object filtruje tajné kódy pro názvy, které začínají znaky IT. Příkaz předá tajné kódy, které odpovídají filtru, do rutiny Update-AzKeyVaultSecret, která je zakáže.
Příklad 4: Nastavení contentType pro všechny verze tajného kódu
$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType
První tři příkazy definují proměnné řetězce, které se mají použít pro parametry VaultName, Name a ContentType . Čtvrtý příkaz používá rutinu Get-AzKeyVaultKey k získání zadaných klíčů a předá klíče rutině Update-AzKeyVaultSecret k nastavení jejich typu obsahu na XML.
Parametry
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ContentType
Typ obsahu tajného kódu. Pokud není zadána, stávající hodnota typu obsahu tajného klíče zůstane beze změny. Odeberte existující hodnotu typu obsahu zadáním prázdného řetězce.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Enable
Pokud je k dispozici, povolte tajný kód, pokud je hodnota true. Pokud je hodnota false, zakažte tajný kód. Pokud není zadáno, stávající hodnota stavu povoleného nebo zakázaného tajného kódu zůstane beze změny.
Type: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Expires
Čas vypršení platnosti tajného kódu v čase UTC. Pokud není zadáno, stávající hodnota doby vypršení platnosti tajného kódu zůstane beze změny.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Tajný objekt
Type: | PSKeyVaultSecretIdentityItem |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Název tajného kódu. Rutina vytvoří plně kvalifikovaný název domény tajného kódu z názvu trezoru, aktuálně vybrané prostředí a název tajného kódu.
Type: | String |
Aliases: | SecretName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NotBefore
Čas UTC, před kterým se tajný kód nedá použít. Pokud není zadána, stávající hodnota atributu NotBefore tajného klíče zůstane beze změny.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Rutina ve výchozím nastavení nevrací objekt. Pokud je tento přepínač zadán, vraťte tajný objekt.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Hashtable představující tajné značky. Pokud není zadáno, stávající značky tajného kódu zůstanou beze změny. Odeberte značku zadáním prázdné hashtable.
Type: | Hashtable |
Aliases: | Tags |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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í.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Version
Verze tajného kódu. Rutina vytvoří plně kvalifikovaný název domény tajného kódu z názvu trezoru, aktuálně vybrané prostředí, název tajného kódu a verzi tajného kódu.
Type: | String |
Aliases: | SecretVersion |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Vstupy
Výstupy
Azure PowerShell
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro