Managed Hsms - Update

リファレンス

サービス:: Key Vault

API バージョン:: 2022-07-01

指定したサブスクリプションのマネージド HSM プールを更新します。

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	マネージド HSM プールの名前
resourceGroupName	path	True	string	マネージド HSM プールを含むリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
location	string	マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。
properties	ManagedHsmProperties	マネージド HSM のプロパティ
sku	ManagedHsmSku	SKU の詳細
tags	object	リソースタグ

応答

名前	型	説明
200 OK	ManagedHsm	修正プログラムが適用されたマネージド HSM プール
202 Accepted	ManagedHsm	受け入れられ、操作は非同期的に完了します。ヘッダー Location: string
Other Status Codes	ManagedHsmError	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ManagedHsm

修正プログラムが適用されたマネージド HSM プール

202 Accepted

ManagedHsm

受け入れられ、操作は非同期的に完了します。

ヘッダー

Location: string

Other Status Codes

ManagedHsmError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Update an existing managed HSM Pool

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01

{
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

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_update.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.begin_update(
        resource_group_name="hsm-group",
        name="hsm1",
        parameters={"tags": {"Dept": "hsm", "Environment": "dogfood", "Slice": "A"}},
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_Update.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

応答のサンプル

状態コード:: 200

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": false,
    "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",
    "Slice": "A"
  }
}

状態コード:: 202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9

{
  "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": "Updating",
    "statusMessage": "ManagedHsm is updating."
  },
  "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",
    "Slice": "A"
  }
}

定義

名前	説明
ActionsRequired	サービスプロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
ActivationStatus	アクティブ化の状態
CreateMode	リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。
Error	サーバーエラー。
identityType	キーコンテナーリソースを作成した ID の種類。
ManagedHsm	詳細が拡張されたリソース情報。
ManagedHsmError	エラー例外。
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

ActivationStatus

列挙

アクティブ化の状態

値	説明
Active	マネージド HSM プールがアクティブです。
Failed	マネージド HSM のアクティブ化に失敗しました。
NotActivated	マネージド HSM プールはまだアクティブ化されていません。
Unknown	マネージド HSM のアクティブ化中に不明なエラーが発生しました。

CreateMode

列挙

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

値	説明
default	新しいマネージド HSM プールを作成します。これが既定のオプションです。
recover	論理的に削除されたリソースからマネージド HSM プールを復旧します。

Error

Object

サーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	内部エラーには、より具体的なエラーコードが含まれています。
message	string	エラーメッセージ。

identityType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

ManagedHsm

Object

詳細が拡張されたリソース情報。

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

Object

エラー例外。

名前	型	説明
error	Error	サーバーエラー。

ManagedHsmProperties

Object

マネージド 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 (date-time)		スケジュールされた消去日 (UTC)。
securityDomainProperties	ManagedHSMSecurityDomainProperties		マネージド HSM セキュリティドメインのプロパティ。
softDeleteRetentionInDays	integer (int32)	90	論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。
statusMessage	string		リソースステータスメッセージ。
tenantId	string (uuid)		マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。

ManagedHSMSecurityDomainProperties

Object

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

名前	型	説明
activationStatus	ActivationStatus	アクティブ化の状態
activationStatusMessage	string	アクティブ化ステータスメッセージ。

ManagedHsmSku

Object

SKU の詳細

名前	型	説明
family	ManagedHsmSkuFamily	マネージド HSM プールの SKU ファミリ
name	ManagedHsmSkuName	マネージド HSM プールの SKU

ManagedHsmSkuFamily

列挙

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

値	説明
B

ManagedHsmSkuName

列挙

マネージド HSM プールの SKU

値	説明
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Object

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

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

MHSMNetworkRuleSet

Object

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

名前	型	説明
bypass	NetworkRuleBypassOptions	ネットワークルールをバイパスできるトラフィックを指定します。 "AzureServices" または "None" を指定できます。指定しない場合、既定値は 'AzureServices' です。
defaultAction	NetworkRuleAction	ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。
ipRules	MHSMIPRule[]	IP アドレス規則の一覧。
virtualNetworkRules	MHSMVirtualNetworkRule[]	仮想ネットワーク規則の一覧。

MHSMPrivateEndpoint

Object

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

名前	型	説明
id	string	プライベートエンドポイントリソースの完全な識別子。

MHSMPrivateEndpointConnectionItem

Object

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

名前	型	説明
etag	string	プライベートエンドポイント接続の状態が変更されるたびに変更されます。
id	string	プライベートエンドポイント接続の ID。
properties.privateEndpoint	MHSMPrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	プライベートリンク接続の承認状態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。

MHSMPrivateLinkServiceConnectionState

Object

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

名前	型	説明
actionsRequired	ActionsRequired	サービスプロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	承認または拒否の理由。
status	PrivateEndpointServiceConnectionStatus	キーコンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

MHSMVirtualNetworkRule

Object

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

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

NetworkRuleAction

列挙

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

値	説明
Allow
Deny

NetworkRuleBypassOptions

列挙

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

値	説明
AzureServices
None

PrivateEndpointConnectionProvisioningState

列挙

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

値	説明
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

列挙

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

値	説明
Approved
Disconnected
Pending
Rejected

ProvisioningState

列挙

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

値	説明
Activated	マネージド HSM プールは、通常使用できる状態です。
Deleting	マネージド HSM プールは現在削除中です。
Failed	マネージド HSM プールのプロビジョニングに失敗しました。
Provisioning	マネージド HSM プールは現在プロビジョニング中です。
Restoring	マネージド HSM プールは、完全な HSM バックアップから復元されています。
SecurityDomainRestore	マネージド HSM プールは、セキュリティドメインの復元アクションを待機しています。
Succeeded	マネージド HSM プールが完全にプロビジョニングされました。
Updating	マネージド HSM プールは現在更新中です。

PublicNetworkAccess

列挙

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

値	説明
Disabled
Enabled

SystemData

Object

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

名前	型	説明
createdAt	string (date-time)	キーコンテナーリソースの作成 (UTC) のタイムスタンプ。
createdBy	string	キーコンテナーリソースを作成した ID。
createdByType	identityType	キーコンテナーリソースを作成した ID の種類。
lastModifiedAt	string (date-time)	キーコンテナーリソースの最終変更 (UTC) のタイムスタンプ。
lastModifiedBy	string	キーコンテナーリソースを最後に変更した ID。
lastModifiedByType	identityType	キーコンテナーリソースを最後に変更した ID の種類。

次の方法で共有

Managed Hsms - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Update an existing managed HSM Pool

要求のサンプル

応答のサンプル

定義

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

その他のリソース