Set-AzKeyVaultSecret
Anahtar kasasında gizli dizi oluşturur veya güncelleştirir.
Sözdizimi
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
Set-AzKeyVaultSecret cmdlet'i, Azure Key Vault'taki bir anahtar kasasında gizli dizi oluşturur veya güncelleştirir. Gizli dizi yoksa, bu cmdlet onu oluşturur. Gizli dizi zaten varsa, bu cmdlet bu gizli dizinin yeni bir sürümünü oluşturur.
Örnekler
Örnek 1: Varsayılan öznitelikleri kullanarak gizli dizi değerini değiştirme
$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 :
İlk komut, ConvertTo-SecureString cmdlet'ini kullanarak bir dizeyi güvenli bir dizeye dönüştürür ve ardından bu dizeyi $Secret değişkeninde depolar. Daha fazla bilgi için Get-Help ConvertTo-SecureString
yazın.
İkinci komut, Contoso adlı anahtar kasasında ITSecret adlı gizli dizinin değerini değiştirir. Gizli dizi değeri, $Secret'de depolanan değer olur.
Örnek 2: Özel öznitelikleri kullanarak gizli dizi değerini değiştirme
$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
İlk komut, ConvertTo-SecureString cmdlet'ini kullanarak bir dizeyi güvenli bir dizeye dönüştürür ve ardından bu dizeyi $Secret değişkeninde depolar. Daha fazla bilgi için Get-Help ConvertTo-SecureString
yazın.
Sonraki komutlar süre sonu tarihi, etiketler ve bağlam türü için özel öznitelikleri tanımlar ve öznitelikleri değişkenlerde depolar.
Son komut, daha önce değişken olarak belirtilen değerleri kullanarak Contoso adlı anahtar kasasında ITSecret adlı gizli anahtarın değerlerini değiştirir.
Örnek 3: Varsayılan öznitelikleri kullanarak (Uri kullanarak) gizli dizi değerini değiştirme
$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 :
Bu komut, gizli dizinin URI'sini kullanarak Contoso adlı Key Vault'ta secret1 adlı gizli dizinin değerini ayarlar veya güncelleştirir.
Örnek 4: Microsoft.PowerShell.SecretManagement modülünde komut Set-Secret azure key vault'ta gizli dizi oluşturma
# 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
Bu örnek, Microsoft.PowerShell.SecretManagement
modülündeki komut Set-Secret
test-kv
azure key vault'ta secureSecret
adlı bir gizli dizi ayarlar.
Parametreler
-Confirm
Cmdlet'i çalıştırmadan önce sizden onay ister.
Tür: | SwitchParameter |
Diğer adlar: | cf |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-ContentType
Gizli dizinin içerik türünü belirtir. Mevcut içerik türünü silmek için boş bir dize belirtin.
Tür: | String |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-DefaultProfile
Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik
Tür: | IAzureContextContainer |
Diğer adlar: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Disable
Bu cmdlet'in gizli diziyi devre dışı bırakdığını gösterir.
Tür: | SwitchParameter |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Expires
Bu cmdlet'in güncelleştirdiği gizli dizi için DateTime nesnesi olarak süre sonunu belirtir.
Bu parametre Eşgüdümlü Evrensel Saat (UTC) kullanır. Get-Help Get-Date
yazın.
Tür: | DateTime |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Id
KeyVault Gizli Dizisinin URI'si.
Lütfen şu biçime uydığından emin olun: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>
Tür: | String |
Diğer adlar: | SecretId |
Position: | 0 |
Default value: | None |
Gerekli: | True |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-InputObject
Gizli dizi nesnesi
Tür: | PSKeyVaultSecretIdentityItem |
Position: | 0 |
Default value: | None |
Gerekli: | True |
İşlem hattı girişini kabul et: | True |
Joker karakterleri kabul et: | False |
-Name
Değiştirileceği gizli dizinin adını belirtir. Bu cmdlet, bu parametrenin belirttiği ada, anahtar kasasının adına ve geçerli ortamınıza göre bir gizli dizinin tam etki alanı adını (FQDN) oluşturur.
Tür: | String |
Diğer adlar: | SecretName |
Position: | 1 |
Default value: | None |
Gerekli: | True |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-NotBefore
DateTime nesnesi olarak, daha önce gizli dizinin kullanılamadığı saati belirtir. Bu parametre UTC kullanır.
Tür: | DateTime |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-SecretValue
Gizli dizi değerini bir SecureString nesnesi olarak belirtir. Get-Help ConvertTo-SecureString
yazın.
Tür: | SecureString |
Position: | 2 |
Default value: | None |
Gerekli: | True |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Tag
Karma tablo biçiminde anahtar-değer çiftleri. Örneğin: @{key0="value0"; key1=$null; key2="value2"}
Tür: | Hashtable |
Diğer adlar: | Tags |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-VaultName
Bu gizli anahtarın ait olduğu anahtar kasasının adını belirtir. Bu cmdlet, bu parametrenin belirttiği ada ve geçerli ortamınıza göre bir anahtar kasasının FQDN'sini oluşturur.
Tür: | String |
Position: | 0 |
Default value: | None |
Gerekli: | True |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-WhatIf
Cmdlet çalıştırılırsa ne olacağını gösterir. Cmdlet çalıştırılmaz.
Tür: | SwitchParameter |
Diğer adlar: | wi |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
Girişler
Çıkışlar
İlişkili Bağlantılar
Azure PowerShell