Managed Hsms - List By Subscription

リファレンス

Service:: Key Vault

API Version:: 2022-07-01

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

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

With optional parameters:

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 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
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

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_hsms.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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 の種類。