你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Get-AzKeyVaultKey

模块:: Az.KeyVault Module

获取 Key Vault 密钥。请注意，有关密钥的详细信息（如密钥类型或密钥大小）仅在查询特定密钥版本时可用。

语法

ByVaultName (默认值)

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>]

说明

Get-AzKeyVaultKey cmdlet 获取 Azure Key Vault 密钥。此 cmdlet 获取密钥保管库或版本中的所有 KeyBundle 对象的特定Microsoft.Azure.Commands.KeyVault.Models.KeyBundle 或列表。

示例

示例 1：获取密钥保管库中的所有密钥

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           :

此命令获取名为 Contoso 的密钥保管库中的所有密钥。

示例 2：获取密钥的当前版本

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           :

此命令在名为 Contoso 的密钥保管库中获取名为 test1 的密钥的当前版本。

示例 3：获取密钥的所有版本

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           :

此命令获取名为 Contoso 的密钥保管库中名为 ITPfx 的所有版本。

示例 4：获取密钥的特定版本

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           :

此命令在名为 Contoso 的密钥保管库中获取名为 test1 的特定密钥版本。运行此命令后，可以通过导航$Key对象来检查键的各种属性。

示例 5：获取已删除但未清除此密钥保管库的所有密钥

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                 :

此命令在名为 Contoso 的密钥保管库中获取以前删除但未清除的所有密钥。

示例 6：获取已删除但未清除此密钥保管库的 ITPfx 密钥。

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                 :

此命令在名为 Contoso 的密钥保管库中获取以前删除但尚未清除的密钥 test3。此命令将返回元数据，例如删除日期，以及此已删除密钥的计划清除日期。

示例 7：使用筛选获取密钥保管库中的所有密钥

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           :

此命令获取以“test”开头的名为 Contoso 的密钥保管库中的所有密钥。

示例 8：将公钥下载为 .pem 文件

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

可以通过指定 -OutFile 参数来下载 RSA 密钥的公钥。这是将受 HSM 保护的密钥导入 Azure Key Vault 的一个步骤。请参见https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

参数

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

参数属性

类型:	IAzureContextContainer
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzContext, AzureRmContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-HsmName

HSM 名称。 Cmdlet 基于名称和当前所选环境构造托管 HSM 的 FQDN。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

HsmByKeyName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByVaultName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-HsmObject

HSM 对象。

参数属性

类型:	PSManagedHsm
默认值:	None
支持通配符:	False
不显示:	False

参数集

HsmByInputObjectVaultName

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByInputObjectKeyName

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByInputObjectKeyVersions

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-HsmResourceId

HSM 资源 ID。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

HsmByResourceIdVaultName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

HsmByResourceIdKeyName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

HsmByResourceIdKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-IncludeVersions

指示此 cmdlet 获取密钥的所有版本。密钥的当前版本是列表中的第一个密钥版本。如果指定此参数，还必须指定 Name 和 VaultName 参数。如果未指定 IncludeVersions 参数，此 cmdlet 将获取具有指定名称的密钥的当前版本。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByInputObjectKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByInputObjectKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByResourceIdKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByResourceIdKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-InputObject

KeyVault 对象。

参数属性

类型:	PSKeyVault
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByInputObjectVaultName

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByInputObjectKeyName

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByInputObjectKeyVersions

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-InRemovedState

指定是否在输出中显示以前删除的键

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByVaultName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByVaultName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByInputObjectVaultName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByInputObjectVaultName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByResourceIdVaultName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByResourceIdVaultName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Name

指定要获取的密钥捆绑的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	True
不显示:	False
别名:	键名

参数集

ByVaultName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByVaultName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByInputObjectVaultName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByInputObjectVaultName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByResourceIdVaultName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByResourceIdVaultName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-OutFile

指定此 cmdlet 保存密钥的输出文件。默认情况下，公钥以 PEM 格式保存。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceId

KeyVault 资源 ID。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByResourceIdVaultName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

ByResourceIdKeyName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

ByResourceIdKeyVersions

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-VaultName

指定此 cmdlet 从中获取密钥的密钥保管库的名称。此 cmdlet 基于此参数指定的名称和所选环境构造密钥保管库的完全限定域名（FQDN）。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByVaultName

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByKeyName

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByKeyVersions

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Version

指定密钥版本。此 cmdlet 基于密钥保管库名称、当前所选环境、密钥名称和密钥版本构造密钥的 FQDN。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False
别名:	KeyVersion

参数集

ByKeyName

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByKeyName

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByInputObjectKeyName

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByInputObjectKeyName

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ByResourceIdKeyName

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

HsmByResourceIdKeyName

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

通过

Get-AzKeyVaultKey

语法

ByVaultName (默认值)

ByKeyName

ByKeyVersions

HsmByKeyName

HsmByVaultName

HsmByKeyVersions

ByInputObjectVaultName

ByInputObjectKeyName

ByInputObjectKeyVersions

HsmByInputObjectVaultName

HsmByInputObjectKeyName

HsmByInputObjectKeyVersions

ByResourceIdVaultName

ByResourceIdKeyName

ByResourceIdKeyVersions

HsmByResourceIdVaultName

HsmByResourceIdKeyName

HsmByResourceIdKeyVersions

说明

示例

示例 1：获取密钥保管库中的所有密钥

示例 2：获取密钥的当前版本

示例 3：获取密钥的所有版本

示例 4：获取密钥的特定版本

示例 5：获取已删除但未清除此密钥保管库的所有密钥

示例 6：获取已删除但未清除此密钥保管库的 ITPfx 密钥。

示例 7：使用筛选获取密钥保管库中的所有密钥

示例 8：将公钥下载为 .pem 文件

参数

-DefaultProfile

参数属性

参数集

-HsmName

参数属性

参数集

-HsmObject

参数属性

参数集

-HsmResourceId

参数属性

参数集

-IncludeVersions

参数属性

参数集

-InputObject

参数属性

参数集

-InRemovedState

参数属性

参数集

-Name

参数属性

参数集

-OutFile

参数属性

参数集

-ResourceId

参数属性

参数集

-VaultName

参数属性

参数集

-Version

参数属性

参数集

CommonParameters

输入

PSKeyVault

String

输出

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

相关链接

反馈