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 參數

名稱	位於	必要	類型	Description
name	path	True	string	受控 HSM 集區的名稱
privateEndpointConnectionName	path	True	string	與受控 hsm 集區相關聯的私人端點連線名稱。
resourceGroupName	path	True	string	包含受控 HSM 集區的資源群組名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
etag	string	每當私人端點連線的狀態有所變更時，就會進行修改。
location	string	應該在其中建立受控 HSM 集區的支援 Azure 位置。
properties.privateEndpoint	MHSMPrivateEndpoint	私人端點對象的屬性。
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	私人連結連線的核准狀態。
sku	ManagedHsmSku	SKU 詳細數據
tags	object	資源標籤

回應

名稱	類型	Description
200 OK	MHSMPrivateEndpointConnection	已成功更新私人端點連線的狀態。標題 Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

MHSMPrivateEndpointConnection

已成功更新私人端點連線的狀態。

標題

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
    }
  }
}

定義

名稱	Description
ActionsRequired	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
CloudError	來自 Key Vault 資源提供者的錯誤回應
CloudErrorBody	來自 Key Vault 資源提供者的錯誤回應
identityType	建立金鑰保存庫資源的身分識別類型。
ManagedHsmSku	SKU 詳細數據
ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
ManagedHsmSkuName	受控 HSM 集區的 SKU
MHSMPrivateEndpoint	私人端點對象屬性。
MHSMPrivateEndpointConnection	私人端點聯機資源。
MHSMPrivateLinkServiceConnectionState	物件，表示私人連結連接的核准狀態。
PrivateEndpointConnectionProvisioningState	布建私人端點連線的狀態。
PrivateEndpointServiceConnectionStatus	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。
SystemData	與金鑰保存庫資源建立和上次修改相關的元數據。

ActionsRequired

列舉型別

訊息，指出服務提供者上的變更是否需要取用者的任何更新。

值	Description
None

CloudError

Object

來自 Key Vault 資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	來自 Key Vault 資源提供者的錯誤回應

CloudErrorBody

Object

來自 Key Vault 資源提供者的錯誤回應

名稱	類型	Description
code	string	錯誤碼。這是可透過程序設計方式取用的助記鍵。
message	string	使用者易記的錯誤訊息。訊息通常會當地語系化，而且可能會因服務版本而有所不同。

identityType

列舉型別

建立金鑰保存庫資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ManagedHsmSku

Object

SKU 詳細數據

名稱	類型	Description
family	ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
name	ManagedHsmSkuName	受控 HSM 集區的 SKU

ManagedHsmSkuFamily

列舉型別

受控 HSM 集區的 SKU 系列

值	Description
B

ManagedHsmSkuName

列舉型別

受控 HSM 集區的 SKU

值	Description
Custom_B32
Custom_B6
Standard_B1