你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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 参数

名称 必需 类型 说明
privateEndpointConnectionName
path True

string

专用终结点连接的名称。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
id

string

专用终结点连接资源 ID。

properties

Properties

专用终结点连接的连接状态。

响应

名称 类型 说明
200 OK

PrivateEndpointConnection

专用终结点连接请求已完成。

202 Accepted

请求批准或拒绝专用终结点连接。 位置标头包含可在其中检查长时间运行的操作状态的 URL。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementApproveOrRejectPrivateEndpointConnection

示例请求

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."
    }
  }
}

示例响应

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."
    }
  }
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointConnectionRequest

批准或拒绝专用终结点连接的请求

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

Properties

专用终结点连接的连接状态。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误时,请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

PrivateEndpoint

专用终结点资源。

名称 类型 说明
id

string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.privateEndpoint

PrivateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

properties.provisioningState

PrivateEndpointConnectionProvisioningState

专用终结点连接资源的预配状态。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointConnectionRequest

批准或拒绝专用终结点连接的请求

名称 类型 说明
id

string

专用终结点连接资源 ID。

properties

Properties

专用终结点连接的连接状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称 类型 说明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

名称 类型 说明
actionsRequired

string

一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。

description

string

批准/拒绝连接的原因。

status

PrivateEndpointServiceConnectionStatus

指示连接是否已由服务的所有者批准/拒绝/删除。

Properties

专用终结点连接的连接状态。

名称 类型 说明
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。