Aracılığıyla paylaş

Set-AzureKeyVaultSecret

  • Başvuru
Modül:
AzureRM.KeyVault

Anahtar kasasında gizli dizi oluşturur veya güncelleştirir.

Uyarı

AzureRM PowerShell modülü 29 Şubat 2024 itibarıyla resmi olarak kullanım dışı bırakılmıştır. Kullanıcıların destek ve güncelleştirmelerin devam etmesini sağlamak için AzureRM'den Az PowerShell modülüne geçmeleri tavsiye edilir.

AzureRM modülü çalışmaya devam edebilir, ancak artık bakım yapılmaz veya desteklenmez ve kullanıcının takdirine ve riskine bağlı olarak sürekli kullanım sağlanır. Az modülüne geçiş konusunda yönergeler için lütfen geçiş kaynaklarımıza bakın.

Sözdizimi

Set-AzureKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureKeyVaultSecret
   [-InputObject] <PSKeyVaultSecretIdentityItem>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set-AzureKeyVaultSecret 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

PS C:\> $Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force
PS C:\> Set-AzureKeyVaultSecret -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 yazın Get-Help ConvertTo-SecureString. İ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

PS C:\> $Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force
PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $NBF =(Get-Date).ToUniversalTime()
PS C:\> $Tags = @{ 'Severity' = 'medium'; 'IT' = 'true'}
PS C:\> $ContentType = 'txt'
PS C:\> Set-AzureKeyVaultSecret -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 yazın Get-Help ConvertTo-SecureString. 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.

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: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. DateTime nesnesi almak için Get-Date cmdlet'ini kullanın. Daha fazla bilgi için yazın Get-Help Get-Date.

Tür:Nullable<T>[DateTime]
Position:Named
Default value:None
Gerekli:False
İş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

Bir DateTime nesnesi olarak, daha önce gizli dizinin kullanılamadığı saati belirtir. Bu parametre UTC kullanır. DateTime nesnesi almak için Get-Date cmdlet'ini kullanın.

Tür:Nullable<T>[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 SecureString nesnesi olarak belirtir. SecureString nesnesi almak için ConvertTo-SecureString cmdlet'ini kullanın. Daha fazla bilgi için yazın Get-Help ConvertTo-SecureString.

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ıyorsa 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

PSKeyVaultSecretIdentityItem

Parametreler: InputObject (ByValue)

Çıkışlar

PSKeyVaultSecret