MHSM Private Endpoint Connections - Put

リファレンス

サービス:: Key Vault

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

マネージド hsm プールに関連付けられている指定されたプライベートエンドポイント接続を更新します。

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	マネージド HSM プールの名前
privateEndpointConnectionName	path	True	string	マネージド HSM プールに関連付けられているプライベートエンドポイント接続の名前。
resourceGroupName	path	True	string	マネージド HSM プールを含むリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
etag	string	プライベートエンドポイント接続の状態が変更されるたびに変更されます。
location	string	マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。
properties.privateEndpoint	MHSMPrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	プライベートリンク接続の承認状態。
sku	ManagedHsmSku	SKU の詳細
tags	object	リソースタグ

応答

名前	型	説明
200 OK	MHSMPrivateEndpointConnection	プライベートエンドポイント接続の状態が正常に更新されました。ヘッダー Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

MHSMPrivateEndpointConnection

プライベートエンドポイント接続の状態が正常に更新されました。

ヘッダー

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

ManagedHsmPutPrivateEndpointConnection

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections/sample-pec?api-version=2022-07-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this."
    }
  }
}

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_put_private_endpoint_connection.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.mhsm_private_endpoint_connections.put(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
        properties={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "My name is Joe and I'm approving this.",
                    "status": "Approved",
                }
            }
        },
    )
    print(response)


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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this.",
      "actionsRequired": "None"
    }
  }
}

定義

名前	説明
ActionsRequired	サービスプロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。
CloudError	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
identityType	キーコンテナーリソースを作成した ID の種類。
ManagedHsmSku	SKU の詳細
ManagedHsmSkuFamily	マネージド HSM プールの SKU ファミリ
ManagedHsmSkuName	マネージド HSM プールの SKU
MHSMPrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
MHSMPrivateEndpointConnection	プライベートエンドポイント接続リソース。
MHSMPrivateLinkServiceConnectionState	プライベートリンク接続の承認状態を表すオブジェクト。
PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	キーコンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。
SystemData	キーコンテナーリソースの作成と最後の変更に関連するメタデータ。

ActionsRequired

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

名前	型	説明
None	string

CloudError

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
error	CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault

CloudErrorBody

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
code	string	エラーコード。これは、プログラムで使用できるニーモニックです。
message	string	わかりやすいエラーメッセージ。通常、メッセージはローカライズされており、サービスのバージョンによって異なる場合があります。

identityType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	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