次の方法で共有


Managed Hsms - List By Subscription

List 操作は、サブスクリプションに関連付けられているマネージド HSM プールに関する情報を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs?$top={$top}&api-version=2022-07-01

URI パラメーター

名前 / 必須 説明
subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True

string

クライアント API のバージョン。

$top
query

integer

int32

返される結果の最大数。

応答

名前 説明
200 OK

ManagedHsmListResult

指定したサブスクリプション内のすべてのマネージド HSM プールに関する情報を取得します。

Other Status Codes

ManagedHsmError

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

List managed HSM Pools in a subscription

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01

応答のサンプル

{
  "value": [
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
      "name": "hsm1",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "dogfood"
      }
    },
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm2.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
      "name": "hsm2",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "production"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

定義

名前 説明
ActionsRequired

サービス プロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。

ActivationStatus

アクティブ化の状態

CreateMode

リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。

Error

サーバー エラー。

identityType

キー コンテナー リソースを作成した ID の種類。

ManagedHsm

拡張された詳細を含むリソース情報。

ManagedHsmError

エラー例外。

ManagedHsmListResult

マネージド HSM プールの一覧

ManagedHsmProperties

マネージド HSM プールのプロパティ

ManagedHSMSecurityDomainProperties

マネージド HSM のセキュリティ ドメイン プロパティ。

ManagedHsmSku

SKU の詳細

ManagedHsmSkuFamily

マネージド HSM プールの SKU ファミリ

ManagedHsmSkuName

マネージド HSM プールの SKU

MHSMIPRule

特定の IP アドレスまたは IP 範囲からのマネージド HSM プールのアクセシビリティを制御する規則。

MHSMNetworkRuleSet

マネージド HSM プールのネットワーク アクセシビリティを制御する一連の規則。

MHSMPrivateEndpoint

プライベート エンドポイント オブジェクトのプロパティ。

MHSMPrivateEndpointConnectionItem

プライベート エンドポイント接続項目。

MHSMPrivateLinkServiceConnectionState

プライベート リンク接続の承認状態を表す オブジェクト。

MHSMVirtualNetworkRule

特定の仮想ネットワークからのマネージド HSM プールのアクセシビリティを制御する規則。

NetworkRuleAction

ipRules と virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。

NetworkRuleBypassOptions

ネットワーク 規則をバイパスできるトラフィックを示します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

PrivateEndpointServiceConnectionStatus

キー コンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

ProvisioningState

プロビジョニングの状態。

PublicNetworkAccess

パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。

SystemData

キー コンテナー リソースの作成と最後の変更に関連するメタデータ。

ActionsRequired

サービス プロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。

名前 説明
None

string

ActivationStatus

アクティブ化の状態

名前 説明
Active

string

マネージド HSM プールがアクティブです。

Failed

string

マネージド HSM のアクティブ化に失敗しました。

NotActivated

string

マネージド HSM プールはまだアクティブ化されていません。

Unknown

string

マネージド hsm のアクティブ化中に不明なエラーが発生しました。

CreateMode

リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。

名前 説明
default

string

新しいマネージド HSM プールを作成します。 既定のオプションです。

recover

string

論理的に削除されたリソースからマネージド HSM プールを復旧します。

Error

サーバー エラー。

名前 説明
code

string

エラー コード。

innererror

Error

内部エラーには、より具体的なエラー コードが含まれています。

message

string

エラー メッセージ。

identityType

キー コンテナー リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

ManagedHsm

拡張された詳細を含むリソース情報。

名前 説明
id

string

マネージド HSM プールの Azure Resource Manager リソース ID。

location

string

マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。

name

string

マネージド HSM プールの名前。

properties

ManagedHsmProperties

マネージド HSM のプロパティ

sku

ManagedHsmSku

SKU の詳細

systemData

SystemData

キー コンテナー リソースの作成と最後の変更に関連するメタデータ。

tags

object

リソース タグ

type

string

マネージド HSM プールのリソースの種類。

ManagedHsmError

エラー例外。

名前 説明
error

Error

サーバー エラー。

ManagedHsmListResult

マネージド HSM プールの一覧

名前 説明
nextLink

string

マネージド HSM プールの次のセットを取得する URL。

value

ManagedHsm[]

マネージド HSM プールの一覧。

ManagedHsmProperties

マネージド HSM プールのプロパティ

名前 規定値 説明
createMode

CreateMode

リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。

enablePurgeProtection

boolean

True

このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護がアクティブになります。回復不可能なハード削除を開始できるのは、Managed HSM サービスのみです。 この機能を有効にすることは元に戻すことはできません。

enableSoftDelete

boolean

True

このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、変更できません。

hsmUri

string

キーに対する操作を実行するためのマネージド HSM プールの URI。

initialAdminObjectIds

string[]

このマネージド hsm プールの初期管理者オブジェクト ID の配列。

networkAcls

MHSMNetworkRuleSet

特定のネットワークの場所からのキー コンテナーのアクセシビリティを制御する規則。

privateEndpointConnections

MHSMPrivateEndpointConnectionItem[]

マネージド HSM プールに関連付けられているプライベート エンドポイント接続の一覧。

provisioningState

ProvisioningState

プロビジョニングの状態。

publicNetworkAccess

PublicNetworkAccess

Enabled

パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。

scheduledPurgeDate

string

スケジュールされた消去日 (UTC)。

securityDomainProperties

ManagedHSMSecurityDomainProperties

マネージド HSM セキュリティ ドメインのプロパティ。

softDeleteRetentionInDays

integer

90

論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保持期間または既定の期間 (90 日間) は回復可能なままになります。 7 ~ 90 の値を受け入れます。

statusMessage

string

リソースの状態メッセージ。

tenantId

string

マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。

ManagedHSMSecurityDomainProperties

マネージド HSM のセキュリティ ドメイン プロパティ。

名前 説明
activationStatus

ActivationStatus

アクティブ化の状態

activationStatusMessage

string

アクティブ化ステータス メッセージ。

ManagedHsmSku

SKU の詳細

名前 説明
family

ManagedHsmSkuFamily

マネージド HSM プールの SKU ファミリ

name

ManagedHsmSkuName

マネージド HSM プールの SKU

ManagedHsmSkuFamily

マネージド HSM プールの SKU ファミリ

名前 説明
B

string

ManagedHsmSkuName

マネージド HSM プールの SKU

名前 説明
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMIPRule

特定の IP アドレスまたは IP 範囲からのマネージド HSM プールのアクセシビリティを制御する規則。

名前 説明
value

string

CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純な IP アドレス) や '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。

MHSMNetworkRuleSet

マネージド HSM プールのネットワーク アクセシビリティを制御する一連の規則。

名前 説明
bypass

NetworkRuleBypassOptions

ネットワーク 規則をバイパスできるトラフィックを示します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。

defaultAction

NetworkRuleAction

ipRules と virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。

ipRules

MHSMIPRule[]

IP アドレス規則の一覧。

virtualNetworkRules

MHSMVirtualNetworkRule[]

仮想ネットワーク規則の一覧。

MHSMPrivateEndpoint

プライベート エンドポイント オブジェクトのプロパティ。

名前 説明
id

string

プライベート エンドポイント リソースの完全識別子。

MHSMPrivateEndpointConnectionItem

プライベート エンドポイント接続項目。

名前 説明
etag

string

プライベート エンドポイント接続の状態が変更されるたびに変更されます。

id

string

プライベート エンドポイント接続の ID。

properties.privateEndpoint

MHSMPrivateEndpoint

プライベート エンドポイント オブジェクトのプロパティ。

properties.privateLinkServiceConnectionState

MHSMPrivateLinkServiceConnectionState

プライベート リンク接続の承認状態。

properties.provisioningState

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

MHSMPrivateLinkServiceConnectionState

プライベート リンク接続の承認状態を表す オブジェクト。

名前 説明
actionsRequired

ActionsRequired

サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。

description

string

承認または却下の理由。

status

PrivateEndpointServiceConnectionStatus

キー コンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

MHSMVirtualNetworkRule

特定の仮想ネットワークからのマネージド HSM プールのアクセシビリティを制御する規則。

名前 説明
id

string

'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。

NetworkRuleAction

ipRules と virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。

名前 説明
Allow

string

Deny

string

NetworkRuleBypassOptions

ネットワーク 規則をバイパスできるトラフィックを示します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。

名前 説明
AzureServices

string

None

string

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

名前 説明
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

キー コンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

名前 説明
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningState

プロビジョニングの状態。

名前 説明
Activated

string

マネージド HSM プールは、通常使用できる状態です。

Deleting

string

マネージド HSM プールは現在削除中です。

Failed

string

マネージド HSM プールのプロビジョニングに失敗しました。

Provisioning

string

マネージド HSM プールは現在プロビジョニング中です。

Restoring

string

マネージド HSM プールは、完全な HSM バックアップから復元されています。

SecurityDomainRestore

string

マネージド HSM プールは、セキュリティ ドメインの復元アクションを待機しています。

Succeeded

string

マネージド HSM プールが完全にプロビジョニングされました。

Updating

string

マネージド HSM プールは現在更新中です。

PublicNetworkAccess

パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。

名前 説明
Disabled

string

Enabled

string

SystemData

キー コンテナー リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

キー コンテナー リソースの作成 (UTC) のタイムスタンプ。

createdBy

string

キー コンテナー リソースを作成した ID。

createdByType

identityType

キー コンテナー リソースを作成した ID の種類。

lastModifiedAt

string

キー コンテナー リソースの最終変更 (UTC) のタイムスタンプ。

lastModifiedBy

string

キー コンテナー リソースを最後に変更した ID。

lastModifiedByType

identityType

キー コンテナー リソースを最後に変更した ID の種類。