Get-AzKeyVaultSecret

Ссылка

Модуль:: Az.KeyVault

Возвращает секреты в хранилище ключей.

Синтаксис

Get-AzKeyVaultSecret
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Get-AzKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Get-AzKeyVaultSecret
   [-Id] <String>
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-ParentResourceId] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-ParentResourceId] <String>
   [-Name] <String>
   [-Version] <String>
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-ParentResourceId] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Описание

Командлет Get-AzKeyVaultSecret получает секреты в хранилище ключей. Этот командлет получает определенный секрет или все секреты в хранилище ключей.

Примеры

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

Get-AzKeyVaultSecret -VaultName 'Contoso'

Vault Name   : contoso
Name         : secret1
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret1
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret2
Enabled      : True
Expires      :
Not Before   :
Created      : 4/11/2018 11:45:06 PM
Updated      : 4/11/2018 11:45:06 PM
Content Type :
Tags         :

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

Пример 2. Получение всех версий определенного секрета

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -IncludeVersions

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

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

Пример 3. Получение текущей версии определенного секрета

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

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

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

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -Version '5d1a74ba2c454439886fb8509b6cab3c'

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

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

Пример 5. Получение текущей версии определенного секрета с помощью URI

Get-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/secret1/'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

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

Пример 6. Получение определенной версии определенного секрета с помощью URI

Get-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/secret1/7128133570f84a71b48d7d0550deb74c'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

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

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

Get-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret2/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

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

Пример 8. Получение значения обычного текста текущей версии определенного секрета

$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainText

Командлет возвращает секрет в виде строки при применении -AsPlainText.

Примечание. При перечислении секретов, т. е. не предоставляя -Name, -AsPlainText игнорируется.

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

Get-AzKeyVaultSecret -VaultName 'Contoso' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Id                   : https://contoso.vault.azure.net:443/secrets/secret1
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Vault Name           : contoso
Name                 : secret2
Id                   : https://contoso.vault.azure.net:443/secrets/secret2
Deleted Date         : 5/7/2018 7:56:34 PM
Scheduled Purge Date : 8/5/2018 7:56:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/6/2018 8:39:15 PM
Updated              : 4/6/2018 10:11:24 PM
Content Type         :
Tags                 :

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

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

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Version              : 689d23346e9c42a2a64f4e3d75094dcc
Id                   : https://contoso.vault.azure.net:443/secrets/secret1/689d23346e9c42a2a64f4e3d75094dcc
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

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

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

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name "secret*"

Vault Name   : contoso
Name         : secret1
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret1
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret2
Enabled      : True
Expires      :
Not Before   :
Created      : 4/11/2018 11:45:06 PM
Updated      : 4/11/2018 11:45:06 PM
Content Type :
Tags         :

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

Пример 12. Получение секрета в Azure Key Vault по команде Get-Secret в модуле Microsoft.PowerShell.SecretManagement

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Get-Secret -Vault AzKeyVault -Name secureSecret -AsPlainText

Password

В этом примере возвращается секрет с именем secureSecret в Azure Key Vault с именем test-kv по команде Get-Secret в модуле Microsoft.PowerShell.SecretManagement.

Параметры

-AsPlainText

При установке командлет преобразует секрет в безопасную строку в расшифрованную строку открытого текста в виде выходных данных.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-DefaultProfile

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

Тип:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Id

Универсальный код ресурса (URI) секрета KeyVault. Убедитесь, что он соответствует формату: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Тип:	String
Aliases:	SecretId
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-IncludeVersions

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InputObject

Объект KeyVault.

Тип:	PSKeyVault
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-InRemovedState

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Name

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

Тип:	String
Aliases:	SecretName
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	True

-ParentResourceId

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

Тип:	String
Aliases:	ResourceId
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-VaultName

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

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Version

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

Тип:	String
Aliases:	SecretVersion
Position:	2
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

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

PSKeyVault

String

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

PSKeyVaultSecretIdentityItem

PSKeyVaultSecret

PSDeletedKeyVaultSecretIdentityItem

PSDeletedKeyVaultSecret

Поделиться через

Get-AzKeyVaultSecret

Синтаксис

Описание

Примеры

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

Пример 2. Получение всех версий определенного секрета

Пример 3. Получение текущей версии определенного секрета

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

Пример 5. Получение текущей версии определенного секрета с помощью URI

Пример 6. Получение определенной версии определенного секрета с помощью URI

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

Пример 8. Получение значения обычного текста текущей версии определенного секрета

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

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

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

Пример 12. Получение секрета в Azure Key Vault по команде Get-Secret в модуле Microsoft.PowerShell.SecretManagement

Параметры

-AsPlainText

-DefaultProfile

-Id

-IncludeVersions

-InputObject

-InRemovedState

-Name

-ParentResourceId

-VaultName

-Version

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

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

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

Поделиться через

Get-AzKeyVaultSecret

Синтаксис

Описание

Примеры

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

Пример 2. Получение всех версий определенного секрета

Пример 3. Получение текущей версии определенного секрета

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

Пример 5. Получение текущей версии определенного секрета с помощью URI

Пример 6. Получение определенной версии определенного секрета с помощью URI

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

Пример 8. Получение значения обычного текста текущей версии определенного секрета

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

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

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

Пример 12. Получение секрета в Azure Key Vault по команде Get-Secret в модуле Microsoft.PowerShell.SecretManagement

Параметры

-AsPlainText

-DefaultProfile

-Id

-IncludeVersions

-InputObject

-InRemovedState

-Name

-ParentResourceId

-VaultName

-Version

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

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

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

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