Private Endpoint Connection - Create Or Update
建立新的私人端點連線或更新現有的連線。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
private
|
path | True |
string |
私人端點連線的名稱。 |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex pattern: |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點聯機資源標識碼。 |
properties |
私人端點連線的連線狀態。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
私人端點連線要求已完成。 |
|
202 Accepted |
要求核准或拒絕私人端點連線。 位置標頭包含可檢查長時間執行作業狀態的URL。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
ApiManagementApproveOrRejectPrivateEndpointConnection
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "The Private Endpoint Connection is approved."
}
}
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
"name": "privateEndpointConnectionName",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Succeeded",
"description": "The request has been approved."
}
}
}
定義
名稱 | Description |
---|---|
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
Private |
私人端點資源。 |
Private |
私人端點聯機資源。 |
Private |
目前的布建狀態。 |
Private |
核准或拒絕私人端點連線的要求 |
Private |
私人端點連線狀態。 |
Private |
服務取用者與提供者之間連線狀態的相關信息集合。 |
Properties |
私人端點連線的連線狀態。 |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
要求中傳送無效欄位的清單,以防發生驗證錯誤。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |
PrivateEndpoint
私人端點資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼 |
PrivateEndpointConnection
私人端點聯機資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.privateEndpoint |
私人端點的資源。 |
|
properties.privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
properties.provisioningState |
私人端點聯機資源的布建狀態。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProvisioningState
目前的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointConnectionRequest
核准或拒絕私人端點連線的要求
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點聯機資源標識碼。 |
properties |
私人端點連線的連線狀態。 |
PrivateEndpointServiceConnectionStatus
私人端點連線狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
服務取用者與提供者之間連線狀態的相關信息集合。
名稱 | 類型 | Description |
---|---|---|
actionsRequired |
string |
訊息,指出服務提供者上的變更是否需要取用者的任何更新。 |
description |
string |
核准/拒絕連線的原因。 |
status |
指出連線是否已由服務的擁有者核准/拒絕/移除。 |
Properties
私人端點連線的連線狀態。
名稱 | 類型 | Description |
---|---|---|
privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |