Private Endpoint Connections - Create Or Update
サービス名前空間の PrivateEndpointConnections を作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
namespace
|
path | True |
string |
名前空間名 正規表現パターン: |
private
|
path | True |
string |
PrivateEndpointConnection 名 |
resource
|
path | True |
string |
Azure サブスクリプション内のリソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.privateEndpoint |
この接続のプライベート エンドポイント リソース。 |
|
properties.privateLinkServiceConnectionState |
接続の状態の詳細。 |
|
properties.provisioningState |
プライベート エンドポイント接続のプロビジョニング状態。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
PrivateEndPoint 接続の状態が正常に作成されました。 |
|
201 Created |
PrivateEndPoint 接続の状態の更新要求が受け入れられます。 |
|
202 Accepted |
PrivateEndPoint 接続の状態の更新要求が受け入れられます。 |
|
Other Status Codes |
操作が失敗した理由を説明する Eventhub エラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
NameSpacePrivateEndPointConnectionCreate
要求のサンプル
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"
}
}
応答のサンプル
{
"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"
}
}
}
{
"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"
}
}
}
{
"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"
}
}
}
定義
名前 | 説明 |
---|---|
Connection |
ConnectionState 情報。 |
created |
リソースを作成した ID の種類。 |
End |
プライベート エンドポイント接続のプロビジョニング状態。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。 |
Private |
PrivateEndpoint 情報。 |
Private |
PrivateEndpointConnection のプロパティ。 |
Private |
接続の状態。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
ConnectionState
ConnectionState 情報。
名前 | 型 | 説明 |
---|---|---|
description |
string |
接続状態の説明。 |
status |
接続の状態。 |
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 |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。
名前 | 型 | 説明 |
---|---|---|
error |
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 |
この接続のプライベート エンドポイント リソース。 |
|
properties.privateLinkServiceConnectionState |
接続の状態の詳細。 |
|
properties.provisioningState |
プライベート エンドポイント接続のプロビジョニング状態。 |
|
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 |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースを最後に変更した ID の種類。 |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |