Aracılığıyla paylaş


Update-AzKeyVaultKey

Anahtar kasasındaki bir anahtarın özniteliklerini güncelleştirir.

Sözdizimi

Update-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [[-Version] <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.

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

-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

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.

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

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şim Anahtarı için süre sonunun yoksayıldığını lütfen unutmayı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

-HsmName

HSM adı. Cmdlet, yönetilen bir HSM'nin FQDN'sini ada ve şu anda seçili ortama göre oluşturur.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et: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.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-InputObject

Anahtar nesnesi

Tür:PSKeyVaultKeyIdentityItem
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-KeyOps

Anahtarla gerçekleştirilebilecek işlemler. Belirtilmezse, anahtarın mevcut anahtar işlemleri değişmeden kalır.

Tür:String[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Name

Anahtar adı. Cmdlet, kasa adından, seçili durumdaki ortamdan ve anahtar adından bir anahtarın FQDN'sini oluşturur.

Tür:String
Diğer adlar:KeyName
Position:1
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-NotBefore

Anahtarın kullanılamayacağı UTC saati. Belirtilmezse, anahtarın mevcut NotBefore özniteliği 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 bir nesne döndürmez. Bu anahtar belirtilirse, güncelleştirilmiş anahtar paketi nesnesini döndürür.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ReleasePolicyPath

JSON ilke tanımını içeren bir dosyanın yolu. Anahtarın dışarı aktarılabildiği ilke kuralları.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Tag

Karma tablo anahtar etiketlerini temsil eder. Belirtilmezse, anahtarın mevcut etiketleri değişmeden kalır.

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

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.

Tür:String
Diğer adlar:KeyVersion
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

PSKeyVaultKeyIdentityItem

Çıkışlar

PSKeyVaultKey