Get-AzKeyVaultKey
Возвращает ключи 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>]
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>]
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 получает ключи 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-файла
Параметры
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure
Свойства параметра
Тип: IAzureContextContainer
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-HsmName
Имя HSM. Командлет создает полное доменное имя управляемого модуля HSM на основе имени и выбранной среды.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: 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
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
HsmByInputObjectVaultName
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
HsmByInputObjectKeyName
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
HsmByInputObjectKeyVersions
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-HsmResourceId
Идентификатор ресурса HSM.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
HsmByResourceIdVaultName
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
HsmByResourceIdKeyName
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
HsmByResourceIdKeyVersions
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-IncludeVersions
Указывает, что этот командлет получает все версии ключа.
Текущая версия ключа является первой в списке.
Если этот параметр указан, необходимо также указать параметры Name и VaultName .
Если параметр IncludeVersions не указан, этот командлет получает текущую версию ключа с указанным именем .
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: 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
Объект KeyVault.
Тип: PSKeyVault
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
ByInputObjectVaultName
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByInputObjectKeyName
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByInputObjectKeyVersions
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-InRemovedState
Указывает, следует ли отображать ранее удаленные ключи в выходных данных.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: 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
Default value: None
Поддерживаются подстановочные знаки: True
DontShow: False
Aliases: KeyName (Имя ключа)
Наборы параметров
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
Указывает выходной файл, для которого этот командлет сохраняет ключ. Открытый ключ сохраняется в формате PEM по умолчанию.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ResourceId
Идентификатор ресурса KeyVault.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByResourceIdVaultName
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ByResourceIdKeyName
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ByResourceIdKeyVersions
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-VaultName
Указывает имя хранилища ключей, из которого этот командлет получает ключи.
Этот командлет создает полное доменное имя хранилища ключей на основе имени, указанного этим параметром, и выбранной среды.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByVaultName
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByKeyName
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByKeyVersions
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Version
Указывает версию ключа.
Этот командлет создает полное доменное имя ключа на основе имени хранилища ключей, выбранной среды, имени ключа и версии ключа.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: 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
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters .
Выходные данные