Partilhar via


Get-AzKeyVaultKey

Obtém chaves do Cofre da Chave. Observe que informações detalhadas sobre uma chave, como tipo de chave ou tamanho de chave, só estão disponíveis ao consultar uma versão específica da chave.

Sintaxe

ByVaultName (Predefinição)

Get-AzKeyVaultKey
    [-VaultName] <String>
    [[-Name] <String>]
    [-InRemovedState]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByKeyName

Get-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [-Version] <String>
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByKeyVersions

Get-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [-IncludeVersions]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByKeyName

Get-AzKeyVaultKey
    [-Name] <String>
    [-Version] <String>
    -HsmName <String>
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByVaultName

Get-AzKeyVaultKey
    [[-Name] <String>]
    -HsmName <String>
    [-InRemovedState]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByKeyVersions

Get-AzKeyVaultKey
    [-Name] <String>
    -HsmName <String>
    [-IncludeVersions]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByInputObjectVaultName

Get-AzKeyVaultKey
    [-InputObject] <PSKeyVault>
    [[-Name] <String>]
    [-InRemovedState]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByInputObjectKeyName

Get-AzKeyVaultKey
    [-InputObject] <PSKeyVault>
    [-Name] <String>
    [-Version] <String>
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByInputObjectKeyVersions

Get-AzKeyVaultKey
    [-InputObject] <PSKeyVault>
    [-Name] <String>
    [-IncludeVersions]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByInputObjectVaultName

Get-AzKeyVaultKey
    [-HsmObject] <PSManagedHsm>
    [[-Name] <String>]
    [-InRemovedState]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByInputObjectKeyName

Get-AzKeyVaultKey
    [-HsmObject] <PSManagedHsm>
    [-Name] <String>
    [-Version] <String>
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByInputObjectKeyVersions

Get-AzKeyVaultKey
    [-HsmObject] <PSManagedHsm>
    [-Name] <String>
    [-IncludeVersions]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceIdVaultName

Get-AzKeyVaultKey
    [[-Name] <String>]
    -ResourceId <String>
    [-InRemovedState]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceIdKeyName

Get-AzKeyVaultKey
    [-Name] <String>
    [-Version] <String>
    -ResourceId <String>
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceIdKeyVersions

Get-AzKeyVaultKey
    [-Name] <String>
    -ResourceId <String>
    [-IncludeVersions]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByResourceIdVaultName

Get-AzKeyVaultKey
    [[-Name] <String>]
    -HsmResourceId <String>
    [-InRemovedState]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByResourceIdKeyName

Get-AzKeyVaultKey
    [-Name] <String>
    [-Version] <String>
    -HsmResourceId <String>
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HsmByResourceIdKeyVersions

Get-AzKeyVaultKey
    [-Name] <String>
    -HsmResourceId <String>
    [-IncludeVersions]
    [-OutFile <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

O cmdlet Get-AzKeyVaultKey obtém chaves do Azure Key Vault. Este cmdlet obtém um Microsoft.Azure.Commands.KeyVault.Models.KeyBundle específico ou uma lista de todos os objetos KeyBundle em um cofre de chaves ou por versão.

Exemplos

Exemplo 1: Obter todas as chaves em um cofre de chaves

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           :

Este comando obtém todas as chaves no cofre de chaves chamado Contoso.

Exemplo 2: Obter a versão atual de uma chave

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           :

Este comando obtém a versão atual da chave chamada test1 no cofre de chaves chamado Contoso.

Exemplo 3: Obter todas as versões de uma chave

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           :

Este comando obtém todas as versões da chave chamada ITPfx no cofre de chaves chamado Contoso.

Exemplo 4: Obter uma versão específica de uma chave

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           :

Este comando obtém uma versão específica da chave chamada test1 no cofre de chaves chamado Contoso. Depois de executar esse comando, você pode inspecionar várias propriedades da chave navegando pelo objeto $Key.

Exemplo 5: Obter todas as chaves que foram excluídas, mas não limpas para este cofre de chaves

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                 :

Este comando obtém todas as chaves que foram excluídas anteriormente, mas não limpas, no cofre de chaves chamado Contoso.

Exemplo 6: Obtém a chave ITPfx que foi excluída, mas não limpa para este cofre de chaves.

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                 :

Este comando obtém a chave test3 que foi excluída anteriormente, mas não limpa, no cofre de chaves chamado Contoso. Esse comando retornará metadados, como a data de exclusão e a data de limpeza agendada dessa chave excluída.

Exemplo 7: Obter todas as chaves em um cofre de chaves usando filtragem

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           :

Este comando obtém todas as chaves no cofre de chaves chamado Contoso que começam com "test".

Exemplo 8: Baixar uma chave pública como um arquivo .pem

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

Você pode baixar a chave pública de uma chave RSA especificando o -OutFile parâmetro. Esta é uma etapa da importação de chaves protegidas por HSM para o Cofre de Chaves do Azure. Veja https://v4.hkg1.meaqua.org/azure/key-vault/keys/hsm-protected-keys

Parâmetros

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-HsmName

Nome HSM. O cmdlet constrói o FQDN de um HSM gerenciado com base no nome e no ambiente selecionado no momento.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

HsmByKeyName
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByVaultName
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-HsmObject

Objeto HSM.

Propriedades dos parâmetros

Tipo:PSManagedHsm
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

HsmByInputObjectVaultName
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByInputObjectKeyName
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByInputObjectKeyVersions
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-HsmResourceId

ID do recurso HSM.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

HsmByResourceIdVaultName
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
HsmByResourceIdKeyName
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
HsmByResourceIdKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-IncludeVersions

Indica que esse cmdlet obtém todas as versões de uma chave. A versão atual de uma chave é a primeira da lista. Se você especificar esse parâmetro, também deverá especificar os parâmetros Name e VaultName . Se você não especificar o parâmetro IncludeVersions , esse cmdlet obterá a versão atual da chave com o Name especificado.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByInputObjectKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByInputObjectKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByResourceIdKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByResourceIdKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Objeto KeyVault.

Propriedades dos parâmetros

Tipo:PSKeyVault
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByInputObjectVaultName
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByInputObjectKeyName
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByInputObjectKeyVersions
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InRemovedState

Especifica se as chaves excluídas anteriormente devem ser mostradas na saída

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByVaultName
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByVaultName
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByInputObjectVaultName
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByInputObjectVaultName
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByResourceIdVaultName
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByResourceIdVaultName
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

Especifica o nome do pacote de chaves a ser obtido.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:True
NãoMostrar:False
Aliases:Nome da chave

Conjuntos de parâmetros

ByVaultName
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByVaultName
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByInputObjectVaultName
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByInputObjectVaultName
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByResourceIdVaultName
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByResourceIdVaultName
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-OutFile

Especifica o arquivo de saída para o qual esse cmdlet salva a chave. A chave pública é salva no formato PEM por padrão.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ResourceId

ID do recurso KeyVault.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByResourceIdVaultName
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
ByResourceIdKeyName
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
ByResourceIdKeyVersions
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-VaultName

Especifica o nome do cofre de chaves do qual esse cmdlet obtém chaves. Este cmdlet constrói o FQDN (nome de domínio totalmente qualificado) de um cofre de chaves com base no nome especificado por esse parâmetro e no ambiente selecionado.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByVaultName
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByKeyName
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByKeyVersions
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Version

Especifica a versão da chave. Este cmdlet constrói o FQDN de uma chave com base no nome do cofre de chaves, no ambiente selecionado no momento, no nome da chave e na versão da chave.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Versão Chave

Conjuntos de parâmetros

ByKeyName
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByKeyName
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByInputObjectKeyName
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByInputObjectKeyName
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ByResourceIdKeyName
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
HsmByResourceIdKeyName
Position:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSKeyVault

String

Saídas

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey