Get-AzKeyVault

リファレンス

モジュール:: Az.KeyVault

キーコンテナーを取得します。

構文

Get-AzKeyVault
   [[-VaultName] <String>]
   [[-ResourceGroupName] <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Get-AzKeyVault
   [-VaultName] <String>
   [-Location] <String>
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Get-AzKeyVault
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

説明

Get-AzKeyVault コマンドレットは、サブスクリプション内のキーコンテナーに関する情報を取得します。サブスクリプション内のすべてのキーコンテナーインスタンスを表示したり、リソースグループまたは特定のキーコンテナーで結果をフィルター処理したりできます。単一のキーコンテナーを取得する場合、このコマンドレットではリソースグループの指定は省略可能ですが、パフォーマンスを向上させるためには、これを行う必要があることに注意してください。

このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。

GET /directoryObjects/{id}
GET /users/{id}
GET /servicePrincipals/{id}
GET /groups/{id}

例

例 1: 現在のサブスクリプション内のすべてのキーコンテナーを取得する

Get-AzKeyVault

Vault Name          : myvault1
Resource Group Name : myrg
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Ke
                      yVault/vaults/myvault1
Tags                :


Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

このコマンドは、現在のサブスクリプション内のすべてのキーコンテナーを取得します。

例 2: 特定のキーコンテナーを取得する

Get-AzKeyVault -VaultName 'myvault'

Vault Name                       : myvault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/myvault
Vault URI                        : https://myvault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : True
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        : get, create, delete, list, update,
                                   import, backup, restore, recover
                                   Permissions to Secrets                     : get, list, set, delete, backup,
                                   restore, recover
                                   Permissions to Certificates                : get, delete, list, create, import,
                                   update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers,
                                   setissuers, recover
                                   Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list,
                                   listsas, regeneratekey, set, setsas, update

Tags                             :

このコマンドは、現在のサブスクリプションの myvault という名前のキーコンテナーを取得します。

例 3: リソースグループ内のキーコンテナーを取得する

Get-AzKeyVault -ResourceGroupName 'myrg1'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

このコマンドは、ContosoPayRollResourceGroup という名前のリソースグループ内のすべてのキーコンテナーを取得します。

例 4: 現在のサブスクリプションで削除されたすべてのキーコンテナーを取得する

Get-AzKeyVault -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

このコマンドは、現在のサブスクリプションで削除されたすべてのキーコンテナーを取得します。

例 5: 削除されたキーコンテナーを取得する

Get-AzKeyVault -VaultName 'myvault4'  -Location 'westus' -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

このコマンドは、現在のサブスクリプションと westus リージョンの myvault4 という名前の削除されたキーコンテナー情報を取得します。

例 6: フィルター処理を使用してキーコンテナーを取得する

Get-AzKeyVault -VaultName 'myvault*'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

このコマンドは、"myvault" で始まるサブスクリプション内のすべてのキーコンテナーを取得します。

パラメーター

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InRemovedState

以前に削除されたコンテナーを出力に表示するかどうかを指定します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Location

削除されたコンテナーの場所。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceGroupName

クエリ対象のキーコンテナーまたはキーコンテナーに関連付けられているリソースグループの名前を指定します。

型:	String
配置:	1
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-SubscriptionId

サブスクリプションの ID です。既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Tag

ハッシュテーブルの形式のキーと値のペア。例: @{key0="value0";key1=$null;key2="value2"}

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VaultName

キーコンテナーの名前を指定します。

型:	String
Aliases:	Name
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

入力

String

Hashtable

出力

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault

次の方法で共有

Get-AzKeyVault

構文

説明

例

例 1: 現在のサブスクリプション内のすべてのキーコンテナーを取得する

例 2: 特定のキーコンテナーを取得する

例 3: リソースグループ内のキーコンテナーを取得する

例 4: 現在のサブスクリプションで削除されたすべてのキーコンテナーを取得する

例 5: 削除されたキーコンテナーを取得する

例 6: フィルター処理を使用してキーコンテナーを取得する

パラメーター

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-SubscriptionId

-Tag

-VaultName

入力

出力

その他のリソース

次の方法で共有

Get-AzKeyVault

構文

説明

例

例 1: 現在のサブスクリプション内のすべてのキー コンテナーを取得する

例 2: 特定のキー コンテナーを取得する

例 3: リソース グループ内のキー コンテナーを取得する

例 4: 現在のサブスクリプションで削除されたすべてのキー コンテナーを取得する

例 5: 削除されたキー コンテナーを取得する

例 6: フィルター処理を使用してキー コンテナーを取得する

パラメーター

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-SubscriptionId

-Tag

-VaultName

入力

出力

関連リンク

その他のリソース

例 1: 現在のサブスクリプション内のすべてのキーコンテナーを取得する

例 2: 特定のキーコンテナーを取得する

例 3: リソースグループ内のキーコンテナーを取得する

例 4: 現在のサブスクリプションで削除されたすべてのキーコンテナーを取得する

例 5: 削除されたキーコンテナーを取得する

例 6: フィルター処理を使用してキーコンテナーを取得する