Get-AzKeyVaultKey

Ссылка

Модуль:: Az.KeyVault

Возвращает ключи Key Vault. Обратите внимание, что подробные сведения о ключе, например типе ключа или размере ключа, доступны только при запросе конкретной версии ключа.

Синтаксис

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

Описание

Командлет Get-AzKeyVaultKey получает ключи Azure Key Vault. Этот командлет получает определенный объект Microsoft.Azure.Commands.KeyVault.Models.KeyBundle или список всех объектов 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           :

Эта команда получает текущую версию ключа с именем test1 в хранилище ключей с именем Contoso.

Пример 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           :

Эта команда получает все версии ключа с именем ITPfx в хранилище ключей с именем Contoso.

Пример 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           :

Эта команда получает определенную версию ключа с именем test1 в хранилище ключей с именем Contoso. После выполнения этой команды можно проверить различные свойства ключа, перейдя к объекту $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                 :

Эта команда получает тест ключа 3, который был удален ранее, но не очищался, в хранилище ключей с именем Contoso. Эта команда вернет метаданные, такие как дата удаления, и запланированная дата очистки этого удаленного ключа.

Пример 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           :

Эта команда получает все ключи в хранилище ключей с именем Contoso, начинающиеся с "test".

Пример 8. Скачивание открытого ключа в виде PEM-файла

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

Вы можете скачать открытый ключ ключа RSA, указав -OutFile параметр. Это один из этапов импорта ключей, защищенных HSM, в Azure Key Vault. См. раздел https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys.

Параметры

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HsmName

Имя HSM. Командлет создает полное доменное имя управляемого модуля HSM на основе имени и выбранной среды.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-HsmObject

Объект HSM.

Type:	PSManagedHsm
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-HsmResourceId

Идентификатор ресурса HSM.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IncludeVersions

Указывает, что этот командлет получает все версии ключа. Текущая версия ключа является первой в списке. Если этот параметр указан, необходимо также указать параметры Name и VaultName . Если параметр IncludeVersions не указан, этот командлет получает текущую версию ключа с указанным именем.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Объект KeyVault.

Type:	PSKeyVault
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InRemovedState

Указывает, следует ли отображать ранее удаленные ключи в выходных данных.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Указывает имя пакета ключей для получения.

Type:	String
Aliases:	KeyName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-OutFile

Указывает выходной файл, для которого этот командлет сохраняет ключ. Открытый ключ сохраняется в формате PEM по умолчанию.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

Идентификатор ресурса KeyVault.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VaultName

Указывает имя хранилища ключей, из которого этот командлет получает ключи. Этот командлет создает полное доменное имя хранилища ключей на основе имени, указанного этим параметром, и выбранной среды.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Version

Указывает версию ключа. Этот командлет создает полное доменное имя ключа на основе имени хранилища ключей, выбранной среды, имени ключа и версии ключа.

Type:	String
Aliases:	KeyVersion
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Входные данные

PSKeyVault

String

Выходные данные

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

Get-AzKeyVaultKey

Синтаксис

Описание

Примеры

Пример 1. Получение всех ключей в хранилище ключей

Пример 2. Получение текущей версии ключа

Пример 3. Получение всех версий ключа

Пример 4. Получение определенной версии ключа

Пример 5. Получение всех ключей, которые были удалены, но не удалены для этого хранилища ключей

Пример 6. Возвращает ключ ITPfx, который был удален, но не удален для этого хранилища ключей.

Пример 7. Получение всех ключей в хранилище ключей с помощью фильтрации

Пример 8. Скачивание открытого ключа в виде PEM-файла

Параметры

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Входные данные

Выходные данные

Обратная связь

Дополнительные ресурсы

Get-AzKeyVaultKey

Синтаксис

Описание

Примеры

Пример 1. Получение всех ключей в хранилище ключей

Пример 2. Получение текущей версии ключа

Пример 3. Получение всех версий ключа

Пример 4. Получение определенной версии ключа

Пример 5. Получение всех ключей, которые были удалены, но не удалены для этого хранилища ключей

Пример 6. Возвращает ключ ITPfx, который был удален, но не удален для этого хранилища ключей.

Пример 7. Получение всех ключей в хранилище ключей с помощью фильтрации

Пример 8. Скачивание открытого ключа в виде PEM-файла

Параметры

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Входные данные

Выходные данные

Связанные ссылки

Обратная связь

Дополнительные ресурсы