Aracılığıyla paylaş


Get-AzKeyVaultKey

Key Vault anahtarlarını alır. Anahtar türü veya anahtar boyutu gibi bir anahtarla ilgili ayrıntılı bilgilerin yalnızca belirli bir anahtar sürümünü sorgularken kullanılabildiğini lütfen not edin.

Sözdizimi

Get-AzKeyVaultKey
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-VaultName] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -HsmName <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -ResourceId <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -ResourceId <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -ResourceId <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -HsmResourceId <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get-AzKeyVaultKey cmdlet'i Azure Key Vault anahtarlarını alır. Bu cmdlet belirli bir Microsoft.Azure.Commands.KeyVault.Models.KeyBundle dosyasını veya bir anahtar kasasında veya sürüme göre tüm KeyBundle nesnelerinin listesini alır.

Örnekler

Örnek 1: Anahtar kasasındaki tüm anahtarları alma

Get-AzKeyVaultKey -VaultName 'contoso'

Vault/HSM Name : contoso
Name           : test1
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test1
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault Name     : contoso
Name           : test2
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test2
Enabled        : True
Expires        : 11/24/2018 6:09:44 PM
Not Before     : 5/24/2018 5:59:44 PM
Created        : 5/24/2018 6:09:44 PM
Updated        : 5/24/2018 6:09:44 PM
Purge Disabled : False
Tags           :

Bu komut Contoso adlı anahtar kasasındaki tüm anahtarları alır.

Örnek 2: Anahtarın geçerli sürümünü alma

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1'

Vault/HSM Name : contoso
Name           : test1
Key Type       : RSA
Key Size       : 2048
Version        : 7fe415d5518240c1a6fce89986b8d334
Id             : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Bu komut Contoso adlı anahtar kasasında test1 adlı anahtarın geçerli sürümünü alır.

Örnek 3: Anahtarın tüm sürümlerini alma

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions

Vault/HSM Name : contoso
Name           : test1
Version        : 7fe415d5518240c1a6fce89986b8d334
Id             : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault/HSM Name     : contoso
Name           : test1
Version        : e4e95940e669407fbdb4298bc21a3e1d
Id             : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
Enabled        : False
Expires        : 11/24/2018 6:08:08 PM
Not Before     : 5/24/2018 5:58:08 PM
Created        : 5/24/2018 6:08:08 PM
Updated        : 5/24/2018 6:08:08 PM
Purge Disabled : False
Tags           :

Bu komut, contoso adlı anahtar kasasında ITPfx adlı anahtarın tüm sürümlerini alır.

Örnek 4: Anahtarın belirli bir sürümünü alma

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d'

Vault/HSM Name : contoso
Name           : test1
Key Type       : RSA
Key Size       : 2048
Version        : e4e95940e669407fbdb4298bc21a3e1d
Id             : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
Enabled        : False
Expires        : 11/24/2018 6:08:08 PM
Not Before     : 5/24/2018 5:58:08 PM
Created        : 5/24/2018 6:08:08 PM
Updated        : 5/24/2018 6:08:08 PM
Purge Disabled : False
Tags           :

Bu komut Contoso adlı anahtar kasasında test1 adlı anahtarın belirli bir sürümünü alır. Bu komutu çalıştırdıktan sonra, $Key nesnesine giderek anahtarın çeşitli özelliklerini inceleyebilirsiniz.

Örnek 5: Bu anahtar kasası için silinmiş ancak temizlenmemiş tüm anahtarları alma

Get-AzKeyVaultKey -VaultName 'contoso' -InRemovedState

Vault/HSM Name       : contoso
Name                 : test3
Id                   : https://contoso.vault.azure.net:443/keys/test3
Deleted Date         : 5/24/2018 8:32:42 PM
Scheduled Purge Date : 8/22/2018 8:32:42 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 5/24/2018 8:32:27 PM
Updated              : 5/24/2018 8:32:27 PM
Purge Disabled       : False
Tags                 :

Bu komut, Contoso adlı anahtar kasasında daha önce silinmiş ancak temizlenmemiş tüm anahtarları alır.

Örnek 6: Bu anahtar kasası için silinmiş ancak temizlenmemiş olan anahtar ITPfx'i alır.

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState

Vault/HSM Name       : contoso
Name                 : test3
Id                   : https://contoso.vault.azure.net:443/keys/test3/1af807cc331a49d0b52b7c75e1b2366e
Deleted Date         : 5/24/2018 8:32:42 PM
Scheduled Purge Date : 8/22/2018 8:32:42 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 5/24/2018 8:32:27 PM
Updated              : 5/24/2018 8:32:27 PM
Purge Disabled       : False
Tags                 :

Bu komut, Contoso adlı anahtar kasasında daha önce silinmiş ancak temizlenmemiş olan anahtar test3'lerini alır. Bu komut, silme tarihi ve bu silinen anahtarın zamanlanmış temizleme tarihi gibi meta verileri döndürür.

Örnek 7: Filtrelemeyi kullanarak anahtar kasasındaki tüm anahtarları alma

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName "test*"

Vault/HSM Name : contoso
Name           : test1
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test1
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault/HSM Name : contoso
Name           : test2
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test2
Enabled        : True
Expires        : 11/24/2018 6:09:44 PM
Not Before     : 5/24/2018 5:59:44 PM
Created        : 5/24/2018 6:09:44 PM
Updated        : 5/24/2018 6:09:44 PM
Purge Disabled : False
Tags           :

Bu komut Contoso adlı anahtar kasasında "test" ile başlayan tüm anahtarları alır.

Örnek 8: Ortak anahtarı .pem dosyası olarak indirme

$path = "D:\public.pem"
Get-AzKeyVaultKey -VaultName $vaultName -KeyName $keyName -OutFile $path

Parametresini belirterek RSA anahtarının -OutFile ortak anahtarını indirebilirsiniz. Bu, HSM korumalı anahtarları Azure Key Vault'a aktarmanın bir adımıdır. Bkz. https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

Parametreler

-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

-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

-HsmObject

HSM nesnesi.

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

-HsmResourceId

HSM Kaynak Kimliği.

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

-IncludeVersions

Bu cmdlet'in bir anahtarın tüm sürümlerini aldığını gösterir. Bir anahtarın geçerli sürümü listedeki ilk sürümdür. Bu parametreyi belirtirseniz Name ve VaultName parametrelerini de belirtmeniz gerekir. IncludeVersions parametresini belirtmezseniz, bu cmdlet anahtarın belirtilen Ada sahip geçerli sürümünü alır.

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

-InputObject

KeyVault nesnesi.

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

-InRemovedState

Daha önce silinen anahtarların çıkışta gösterilip gösterilmeyeceğini belirtir

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

-Name

Alınacak anahtar paketinin adını belirtir.

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:True

-OutFile

Bu cmdlet'in anahtarı kaydettiği çıkış dosyasını belirtir. Ortak anahtar varsayılan olarak PEM biçiminde kaydedilir.

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

-ResourceId

KeyVault Kaynak Kimliği.

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

-VaultName

Bu cmdlet'in anahtarları aldığı anahtar kasasının adını belirtir. Bu cmdlet, anahtar kasasının tam etki alanı adını (FQDN) bu parametrenin belirttiği ada ve seçtiğiniz 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ünü belirtir. Bu cmdlet, anahtar kasası adına, seçili durumdaki ortamınıza, anahtar adına ve anahtar sürümüne göre bir anahtarın FQDN'sini oluşturur.

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

Girişler

PSKeyVault

String

Çıkışlar

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey