Private Endpoint Connections - Create Or Update

リファレンス

Service:: Event Hubs

API Version:: 2024-01-01

サービス名前空間の PrivateEndpointConnections を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01

URI パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string	名前空間名 Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
privateEndpointConnectionName	path	True	string	PrivateEndpointConnection 名
resourceGroupName	path	True	string	Azure サブスクリプション内のリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
properties.privateEndpoint	PrivateEndpoint	この接続のプライベートエンドポイントリソース。
properties.privateLinkServiceConnectionState	ConnectionState	接続の状態の詳細。
properties.provisioningState	EndPointProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。

応答

名前	型	説明
200 OK	PrivateEndpointConnection	PrivateEndPoint 接続の状態が正常に作成されました。
201 Created	PrivateEndpointConnection	PrivateEndPoint 接続の状態の更新要求が受け入れられます。
202 Accepted	PrivateEndpointConnection	PrivateEndPoint 接続の状態の更新要求が受け入れられます。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Eventhub エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

例

NameSpacePrivateEndPointConnectionCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Status code:: 202

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

定義

名前	説明
ConnectionState	ConnectionState 情報。
createdByType	リソースを作成した ID の種類。
EndPointProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。
PrivateEndpoint	PrivateEndpoint 情報。
PrivateEndpointConnection	PrivateEndpointConnection のプロパティ。
PrivateLinkConnectionStatus	接続の状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ConnectionState

ConnectionState 情報。

名前	型	説明
description	string	接続状態の説明。
status	PrivateLinkConnectionStatus	接続の状態。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

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

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。

名前	型	説明
error	ErrorDetail	error オブジェクト。

PrivateEndpoint

PrivateEndpoint 情報。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子。

PrivateEndpointConnection

PrivateEndpointConnection のプロパティ。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.privateEndpoint	PrivateEndpoint	この接続のプライベートエンドポイントリソース。
properties.privateLinkServiceConnectionState	ConnectionState	接続の状態の詳細。
properties.provisioningState	EndPointProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
systemData	systemData	このリソースに関連するシステムメタデータ。
type	string	リソースの型。例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

接続の状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

systemData

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

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