Update-AzKeyVaultSecret
Anahtar kasasında gizli dizi özniteliklerini güncelleştirir.
Sözdizimi
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
Update-AzKeyVaultSecret cmdlet'i, anahtar kasasındaki bir gizli dizinin düzenlenebilir özniteliklerini güncelleştirir.
Örnekler
Örnek 1: Gizli dizinin özniteliklerini değiştirme
$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
İlk dört komut, bitiş tarihi, NotBefore tarihi, etiketler ve bağlam türü için öznitelikleri tanımlar ve öznitelikleri değişkenlerde depolar. Son komut, depolanan değişkenleri kullanarak ContosoVault adlı anahtar kasasında İk adlı gizli diziye ilişkin öznitelikleri değiştirir.
Örnek 2: Gizli dizi için etiketleri ve içerik türünü silme
Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}
Bu komut, Contoso adlı anahtar kasasında İk adlı gizli dizinin belirtilen sürümü için etiketleri ve içerik türünü siler.
Örnek 3: Adı BT ile başlayan gizli dizilerin geçerli sürümünü devre dışı bırakma
$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False
İlk komut Contoso dize değerini $Vault değişkeninde depolar. İkinci komut, BT dize değerini $Prefix değişkeninde depolar. Üçüncü komut, belirtilen anahtar kasasındaki gizli dizileri almak için Get-AzKeyVaultSecret cmdlet'ini kullanır ve ardından bu gizli dizileri Where-Object cmdlet'ine geçirir. Where-Object cmdlet'i, BT karakterleriyle başlayan adların gizli dizilerini filtreler. Komutu, filtreyle eşleşen gizli dizileri Update-AzKeyVaultSecret cmdlet'ine aktarır ve bu da bunları devre dışı bırakır.
Örnek 4: Gizli dizinin tüm sürümleri için ContentType değerini ayarlama
$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType
İlk üç komut VaultName, Name ve ContentType parametreleri için kullanılacak dize değişkenlerini tanımlar. Dördüncü komut, belirtilen anahtarları almak için Get-AzKeyVaultKey cmdlet'ini kullanır ve içerik türünü XML olarak ayarlamak için anahtarları Update-AzKeyVaultSecret cmdlet'ine aktarır.
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ü. Belirtilmezse, gizli dizinin içerik türünün mevcut değeri değişmeden kalır. Boş bir dize belirterek mevcut içerik türü değerini kaldırın.
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 |
-Enable
Varsa, değer doğruysa gizli diziyi etkinleştirin. Değer false ise gizli diziyi devre dışı bırakın. Belirtilmezse, gizli dizinin etkin/devre dışı durumunun mevcut değeri değişmeden kalır.
Tür: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Expires
Utc saatinde gizli dizinin sona erme zamanı. Belirtilmezse, gizli dizinin süre sonu süresinin mevcut değeri değişmeden kalır.
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
Gizli dizi adı. Cmdlet, kasa adından, seçili durumdaki ortamdan ve gizli dizi adından bir gizli dizinin FQDN'sini 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
Önceki gizli dizinin kullanılamadığı UTC saati. Belirtilmezse, gizli dizinin NotBefore özniteliğinin mevcut değeri değişmeden kalır.
Tür: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-PassThru
Cmdlet varsayılan olarak nesne döndürmez. Bu anahtar belirtilirse Gizli dizi nesnesini döndür.
Tür: | SwitchParameter |
Position: | Named |
Default value: | None |
Gerekli: | False |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Tag
Gizli dizi etiketlerini temsil eden bir karma tablo. Belirtilmezse, gizli dizinin mevcut etiketleri değişmeden kalır. Boş bir Hashtable belirterek etiketi kaldırın.
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
Kasa adı. Cmdlet, bir kasanın FQDN'sini ada ve o anda seçili olan ortama göre oluşturur.
Tür: | String |
Position: | 0 |
Default value: | None |
Gerekli: | True |
İşlem hattı girişini kabul et: | False |
Joker karakterleri kabul et: | False |
-Version
Gizli dizi sürümü. Cmdlet, kasa adından, şu anda seçili ortamdan, gizli dizi adından ve gizli dizi sürümünden bir gizli dizinin FQDN'sini oluşturur.
Tür: | String |
Diğer adlar: | SecretVersion |
Position: | 2 |
Default value: | None |
Gerekli: | False |
İş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
Çıkışlar
Azure PowerShell