Get-AzureKeyVaultKey
Key Vault キーを取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Get-AzureKeyVaultKey
[-VaultName] <String>
[[-Name] <String>]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-Version] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-IncludeVersions]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-InputObject] <PSKeyVault>
[[-Name] <String>]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-InputObject] <PSKeyVault>
[-Name] <String>
[-Version] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-InputObject] <PSKeyVault>
[-Name] <String>
[-IncludeVersions]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-ResourceId] <String>
[[-Name] <String>]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-ResourceId] <String>
[-Name] <String>
[-Version] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultKey
[-ResourceId] <String>
[-Name] <String>
[-IncludeVersions]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzureKeyVaultKey コマンドレットは、Azure Key Vault キーを取得します。 このコマンドレットは、特定 の Microsoft.Azure.Commands.KeyVault.Models.KeyBundle 、またはキー コンテナー内またはバージョン別のすべての KeyBundle オブジェクトの一覧を取得します。
例
例 1: キー コンテナー内のすべてのキーを取得する
PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso'
Vault 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: キーの現在のバージョンを取得する
PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1'
Vault 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 :
このコマンドは、Contoso という名前のキー コンテナー内の test1 という名前のキーの現在のバージョンを取得します。
例 3: キーのすべてのバージョンを取得する
PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions
Vault 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 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: キーの特定のバージョンを取得する
PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d'
Vault 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 という名前のキー コンテナー内の test1 という名前の特定のバージョンのキーを取得します。 このコマンドを実行した後、$Key オブジェクト内を移動することで、キーのさまざまなプロパティを調べることができます。
例 5: このキー コンテナーに対して削除されたが消去されていないすべてのキーを取得します。
PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -InRemovedState
Vault 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 を取得します。
PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState
Vault 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 を取得します。 このコマンドは、削除日や、この削除されたキーのスケジュールされた削除日などのメタデータを返します。
パラメーター
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-IncludeVersions
このコマンドレットがキーのすべてのバージョンを取得することを示します。 キーの現在のバージョンは、リストの最初のバージョンです。 このパラメーターを指定する場合は、Name パラメーターと VaultName パラメーターも指定する必要があります。 IncludeVersions パラメーターを指定しない場合、このコマンドレットは、指定された Name を持つキーの現在のバージョンを取得します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
KeyVault オブジェクト。
型: | PSKeyVault |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-InRemovedState
以前に削除したキーを出力に表示するかどうかを指定します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
取得するキー バンドルの名前を指定します。
型: | String |
Aliases: | KeyName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceId
KeyVault リソース ID。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-VaultName
このコマンドレットがキーを取得するキー コンテナーの名前を指定します。 このコマンドレットは、このパラメーターが指定する名前と選択した環境に基づいて、キー コンテナーの完全修飾 doメイン 名前 (FQDN) を構築します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Version
キーのバージョンを指定します。 このコマンドレットは、キー コンテナー名、現在選択されている環境、キー名、およびキーのバージョンに基づいて、キーの FQDN を構築します。
型: | String |
Aliases: | KeyVersion |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
Parameters: InputObject (ByValue)
出力
PSDeletedKeyVaultKeyIdentityItem