Update-AzKeyVaultKey
Anahtar kasasındaki bir anahtarın özniteliklerini güncelleştirir.
Syntax
Default (Varsayılan)
Update-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
HsmInteractive
Update-AzKeyVaultKey
[-Name] <String>
[[-Version] <String>]
-HsmName <String>
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Immutable]
[-ReleasePolicyPath <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update-AzKeyVaultKey cmdlet'i, anahtar kasasındaki bir anahtarın düzenlenebilir özniteliklerini güncelleştirir.
Örnekler
Örnek 1: Anahtarı etkinleştirmek için değiştirme ve son kullanma tarihini ve etiketleri ayarlama
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru
Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags : Name Value
Severity high
Accounting true
İlk komut Get-Date cmdlet'ini kullanarak bir DateTime nesnesi oluşturur. Bu nesne, gelecekte iki yıl süre belirtir. Komut bu tarihi $Expires değişkeninde depolar.
Daha fazla bilgi için yazın Get-Help Get-Date.
İkinci komut, yüksek önem derecesi ve Muhasebe etiket değerlerini depolamak için bir değişken oluşturur.
Son komut, ITSoftware adlı bir anahtarı değiştirir. komutu anahtarı etkinleştirir, süre sonu süresini $Expires depolandığı zamana ayarlar ve $Tags depolanan etiketleri ayarlar.
Örnek 2: Tüm etiketleri silmek için anahtarı değiştirme
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}
Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags :
Bu komutlar, ITSoftware adlı anahtarın belirli bir sürümü için tüm etiketleri siler.
Parametreler
-Confirm
Cmdlet'i çalıştırmadan önce sizden onay ister.
Parametre özellikleri
Tür: SwitchParameter
Default value: None
Joker karakterleri destekler: False
DontShow: False
Diğer adlar: Cf
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-DefaultProfile
Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.
Parametre özellikleri
Tür: IAzureContextContainer
Default value: None
Joker karakterleri destekler: False
DontShow: False
Diğer adlar: AzContext, AzureRmContext, AzureCredential
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-Enable
true değeri anahtarı etkinleştirir ve false değeri anahtarı devre dışı bırakır.
Belirtilmezse, mevcut etkin/devre dışı durumu değişmeden kalır.
Parametre özellikleri
Tür: Nullable<T> [ Boolean ]
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-Expires
Bir anahtarın UTC saatinde sona erme zamanı.
Belirtilmezse, anahtarın mevcut süre sonu süresi değişmeden kalır.
BYOK işleminde kullanılan Anahtar Değişimi Anahtarı için süre sonu değerlerinin yoksayıldığını lütfen unutmayın.
Parametre özellikleri
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-HsmName
HSM adı. Cmdlet, yönetilen bir HSM'nin FQDN'sini ada ve şu anda seçili ortama göre oluşturur.
Parametre özellikleri
Tür: String
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
HsmInteractive
Position: Named
Zorunlu: True
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-Immutable
Yayın ilkesini sabit durum olarak ayarlar. Sabit olarak işaretlendikten sonra bu bayrak sıfırlanamaz ve ilke hiçbir koşulda değiştirilemez.
Parametre özellikleri
Tür: SwitchParameter
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
HsmInteractive
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
Anahtar nesnesi
InputObject
Position: 0
Zorunlu: True
İşlem hattından gelen değer: True
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-KeyOps
Anahtarla gerçekleştirilebilecek işlemler.
Belirtilmezse, anahtarın mevcut anahtar işlemleri değişmeden kalır.
Parametre özellikleri
Tür: String [ ]
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-Name
Anahtar adı.
Cmdlet, kasa adından, seçili durumdaki ortamdan ve anahtar adından bir anahtarın FQDN'sini oluşturur.
Parametre özellikleri
Tür: String
Default value: None
Joker karakterleri destekler: False
DontShow: False
Diğer adlar: Anahtar Adı
Parametre kümeleri
Default
Position: 1
Zorunlu: True
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
HsmInteractive
Position: 1
Zorunlu: True
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-NotBefore
Anahtarın kullanılamayacağı UTC saati.
Belirtilmezse, anahtarın mevcut NotBefore özniteliği değişmeden kalır.
Parametre özellikleri
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-PassThru
Cmdlet varsayılan olarak bir nesne döndürmez.
Bu anahtar belirtilirse, güncelleştirilmiş anahtar paketi nesnesini döndürür.
Parametre özellikleri
Tür: SwitchParameter
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-ReleasePolicyPath
JSON ilke tanımını içeren bir dosyanın yolu. Anahtarın dışarı aktarılabildiği ilke kuralları.
Parametre özellikleri
Tür: String
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
HsmInteractive
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-Tag
Karma tablo anahtar etiketlerini temsil eder.
Belirtilmezse, anahtarın mevcut etiketleri değişmeden kalır.
Parametre özellikleri
Tür: Hashtable
Default value: None
Joker karakterleri destekler: False
DontShow: False
Diğer adlar: Etiketler
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-VaultName
Kasa adı.
Cmdlet, bir kasanın FQDN'sini ada ve o anda seçili olan ortama göre oluşturur.
Parametre özellikleri
Tür: String
Default value: None
Joker karakterleri destekler: False
DontShow: False
Parametre kümeleri
Default
Position: 0
Zorunlu: True
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-Version
Anahtar sürümü.
Cmdlet kasa adından, şu anda seçili ortamdan, anahtar adından ve anahtar sürümünden bir anahtarın FQDN'sini oluşturur.
Parametre özellikleri
Tür: String
Default value: None
Joker karakterleri destekler: False
DontShow: False
Diğer adlar: KeyVersion
Parametre kümeleri
(All)
Position: 2
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
-WhatIf
Cmdlet çalıştırılırsa ne olacağını gösterir.
Cmdlet çalıştırılmaz.
Parametre özellikleri
Tür: SwitchParameter
Default value: None
Joker karakterleri destekler: False
DontShow: False
Diğer adlar: Wi
Parametre kümeleri
(All)
Position: Named
Zorunlu: False
İşlem hattından gelen değer: False
Özellik adına göre işlem hattından gelen değer: False
Kalan bağımsız değişkenlerden elde edilen değer: False
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters .
Çıkışlar