Get-AzKeyVaultManagedHsm

  • リファレンス
モジュール:
Az.KeyVault

マネージド HSM を取得します。

構文

Get-AzKeyVaultManagedHsm
   [[-Name] <String>]
   [[-ResourceGroupName] <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]
Get-AzKeyVaultManagedHsm
   [-Name] <String>
   [-Location] <String>
   [-InRemovedState]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]
Get-AzKeyVaultManagedHsm
   [-InRemovedState]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

説明

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

例

例 1: 現在のサブスクリプション内のすべてのマネージド HSM を取得する

Get-AzKeyVaultManagedHsm

Name    Resource Group Name Location SKU        ProvisioningState Security Domain ActivationStatus
----    ------------------- -------- ---        ----------------- --------------------------------
myhsm   test-rg              eastus   StandardB1 Succeeded         Active

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

例 2: 特定のマネージド HSM を取得する

Get-AzKeyVaultManagedHsm -Name 'myhsm'

Name    Resource Group Name Location SKU        ProvisioningState Security Domain ActivationStatus
----    ------------------- -------- ---        ----------------- --------------------------------
myhsm   test-rg              eastus   StandardB1 Succeeded         Active

このコマンドは、現在のサブスクリプションの myhsm という名前のマネージド HSM を取得します。

例 3: リソース グループ内のマネージド HSM を取得する

Get-AzKeyVaultManagedHsm -ResourceGroupName 'myrg1'

Name  Resource Group Name Location    SKU        ProvisioningState Security Domain ActivationStatus
----  ------------------- --------    ---        ----------------- --------------------------------
myhsm myrg1               eastus2euap StandardB1 Succeeded         Active

このコマンドは、myrg1 という名前のリソース グループ内のすべてのマネージド HSM を取得します。

例 4: フィルター処理を使用してマネージド HSM を取得する

Get-AzKeyVaultManagedHsm -Name 'myhsm*'

Name  Resource Group Name Location    SKU        ProvisioningState Security Domain ActivationStatus
----  ------------------- --------    ---        ----------------- --------------------------------
myhsm myrg1               eastus2euap StandardB1 Succeeded         Active

このコマンドは、"myhsm" で始まるサブスクリプション内のすべてのマネージド HSM を取得します。

例 5: 削除された管理対象 HSM を一覧表示する

Get-AzKeyVaultManagedHsm -InRemovedState

Name                     Location      DeletionDate           ScheduledPurgeDate    Purge Protection Enabled?
----                     --------      ------------           ------------------    -------------------------
xxxxxxxx-mhsm-4op2n2g4xe eastus2       12/30/2021 2:29:00 AM  3/30/2022 2:29:00 AM  True
xxxxxxx-mhsm-ertopo7tnxa westus        12/29/2021 11:48:42 PM 3/29/2022 11:48:42 PM True
xxxxxxx-mhsm-gg66fgctz67 westus        12/29/2021 11:48:42 PM 3/29/2022 11:48:42 PM False
xxxxxxx-mhsm-2m5jiop6mfo westcentralus 12/30/2021 12:26:14 AM 3/30/2022 12:26:14 AM True

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

パラメーター

-DefaultProfile

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

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

-InRemovedState

以前に削除したマネージド HSM プールを出力に表示するかどうかを指定します。

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

-Location

削除されたマネージド HSM プールの場所。

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

-Name

HSM 名。 コマンドレットは、名前と現在選択されている環境に基づいて HSM の FQDN を構築します。

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

-ResourceGroupName

クエリ対象のマネージド HSM に関連付けられているリソース グループの名前を指定します。

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

-SubscriptionId

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

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

-Tag

マネージド HSM の一覧をフィルター処理する、指定したタグのキーと省略可能な値を指定します。

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

入力

String

Hashtable

出力

PSManagedHsm

PSDeletedManagedHsm

PSKeyVaultIdentityItem