Private Endpoint Connections - Create Or Update
建立或更新服務命名空間的 PrivateEndpointConnections。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-11-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
namespace
|
path | True |
string |
命名空間名稱 |
private
|
path | True |
string |
PrivateEndpointConnection 名稱 |
resource
|
path | True |
string |
Azure 訂用帳戶內的資源組名。 |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties.privateEndpoint |
此連線的私人端點資源。 |
|
properties.privateLinkServiceConnectionState |
線上狀態的詳細數據。 |
|
properties.provisioningState |
私人端點聯機的布建狀態。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功建立 PrivateEndPoint 連線的狀態。 |
|
201 Created |
要求更新已接受 PrivateEndPoint 連線的狀態。 |
|
202 Accepted |
要求更新已接受 PrivateEndPoint 連線的狀態。 |
|
Other Status Codes |
描述作業失敗原因的 ServiceBus 錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
NameSpacePrivateEndPointConnectionCreate
範例要求
PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2021-11-01
{
"properties": {
"privateEndpoint": {
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
},
"privateLinkServiceConnectionState": {
"status": "Rejected",
"description": "testing"
},
"provisioningState": "Succeeded"
}
}
範例回覆
{
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
"name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
"type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved"
}
}
}
{
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
"name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
"type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved"
}
}
}
{
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
"name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
"type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved"
}
}
}
定義
名稱 | Description |
---|---|
Connection |
ConnectionState 資訊。 |
created |
建立資源的身分識別類型。 |
End |
私人端點聯機的布建狀態。 |
Error |
error 物件。 |
Error |
資源管理錯誤其他資訊。 |
Error |
資源管理錯誤回應。 |
Private |
PrivateEndpoint 資訊。 |
Private |
PrivateEndpointConnection 的屬性。 |
Private |
線上的狀態。 |
system |
與建立和上次修改資源相關的元數據。 |
ConnectionState
ConnectionState 資訊。
名稱 | 類型 | Description |
---|---|---|
description |
string |
線上狀態的描述。 |
status |
線上的狀態。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EndPointProvisioningState
私人端點聯機的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
Error
error 物件。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorResponse
資源管理錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
PrivateEndpoint
PrivateEndpoint 資訊。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼。 |
PrivateEndpointConnection
PrivateEndpointConnection 的屬性。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 Ex - /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
線上的狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改資源的身分識別類型。 |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |