Get-AzKeyVaultSecret
キー コンテナー内のシークレットを取得します。
構文
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
[-ResourceId] <String>
[[-Name] <String>]
[-InRemovedState]
[-AsPlainText]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzKeyVaultSecret
[-ResourceId] <String>
[-Name] <String>
[-Version] <String>
[-AsPlainText]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzKeyVaultSecret
[-ResourceId] <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 :このコマンドは、Contoso という名前のキー コンテナー内の secret1 という名前のシークレットのすべてのバージョンを取得します。
例 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 :このコマンドは、Contoso という名前のキー コンテナー内の secret1 という名前のシークレットの現在のバージョンを取得します。
例 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 :このコマンドは、Contoso という名前のキー コンテナー内の secret1 という名前の特定のバージョンのシークレットを取得します。
例 5: 特定のシークレットの現在のバージョンのプレーン テキスト値を取得する
$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainTextコマンドレットは、適用されると -AsPlainText シークレットを文字列として返します。
注: シークレットを一覧表示する場合、つまり指定-Name-AsPlainTextしない場合は無視されます。
例 6: このキー コンテナーに対して削除されたが消去されていないすべてのシークレットを取得します。
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 という名前のキー コンテナーで以前に削除されたが消去されていないすべてのシークレットを取得します。
例 7: このキー コンテナーに対して削除されたが消去されていないシークレット 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 :このコマンドは、Contoso という名前のキー コンテナーで以前に削除されたシークレット 'secret1' を取得しますが、消去はされていません。 このコマンドは、削除日や、この削除されたシークレットのスケジュールされた削除日などのメタデータを返します。
例 8: フィルター処理を使用して、キー コンテナー内のすべてのシークレットの現在のバージョンをすべて取得する
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 :このコマンドは、"secret" で始まる Contoso という名前のキー コンテナー内のすべてのシークレットの現在のバージョンを取得します。
例 9: モジュール Microsoft.PowerShell.SecretManagement の Get-Secret コマンドを使用して Azure Key Vault でシークレットを取得する
# 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 "Password" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure
Get-Secret -Vault AzKeyVault -Name secureSecret -AsPlainText
Passwordこの例では、モジュールMicrosoft.PowerShell.SecretManagement内のコマンドGet-Secretによって名前が付けられた secureSecret Azure Key Vault で名前が付けられたtest-kvシークレットを取得します。
パラメーター
-AsPlainText
設定すると、コマンドレットはセキュリティで保護された文字列内のシークレットを、復号化されたプレーンテキスト文字列に出力として変換します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeVersions
このコマンドレットがシークレットのすべてのバージョンを取得することを示します。 シークレットの現在のバージョンは、リストの最初のバージョンです。 このパラメーターを指定する場合は、Name パラメーターと VaultName パラメーターも指定する必要があります。 IncludeVersions パラメーターを指定しない場合、このコマンドレットは、指定された Name を持つシークレットの現在のバージョンを取得します。
| 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: | SecretName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ResourceId
KeyVault リソース ID。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VaultName
シークレットが属するキー コンテナーの名前を指定します。 このコマンドレットは、このパラメーターが指定する名前と現在の環境に基づいて、キー コンテナーの完全修飾 doメイン 名 (FQDN) を構築します。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
シークレットのバージョンを指定します。 このコマンドレットは、キー コンテナー名、現在選択されている環境、シークレット名、シークレットバージョンに基づいてシークレットの FQDN を構築します。
| Type: | String |
| Aliases: | SecretVersion |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
出力
PSDeletedKeyVaultSecretIdentityItem
関連リンク
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示