Web Apps - Get Private Endpoint Connection

Ссылка

Service:: App Service

API Version:: 2023-12-01

Описание для получения подключения к частной конечной точке

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-12-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя сайта.
privateEndpointConnectionName	path	True	string	Имя подключения к частной конечной точке.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой принадлежит ресурс. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 0000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Версия API

Ответы

Имя	Тип	Описание
200 OK	RemotePrivateEndpointConnectionARMResource	ОК
Other Status Codes	DefaultErrorResponse	Служба приложений ответ об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get a private endpoint connection for a site.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin.",
      "actionsRequired": ""
    }
  }
}

Определения

Имя	Описание
ArmIdWrapper	Оболочка для идентификатора ресурса ARM
DefaultErrorResponse	Служба приложений ответ об ошибке.
Details
Error	Модель ошибок.
PrivateLinkConnectionState	Состояние подключения к приватному каналу
RemotePrivateEndpointConnectionARMResource	Ресурс ARM удаленного подключения к частной конечной точке.

ArmIdWrapper

Оболочка для идентификатора ресурса ARM

Имя	Тип	Описание
id	string

DefaultErrorResponse

Служба приложений ответ об ошибке.

Имя	Тип	Описание
error	Error	Модель ошибок.

Details

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

Error

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
details	Details[]	Подробные сведения об ошибках.
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

PrivateLinkConnectionState

Состояние подключения к приватному каналу

Имя	Тип	Описание
actionsRequired	string	ДействияСпросить подключение по приватному каналу
description	string	Описание подключения по приватному каналу
status	string	Состояние подключения к приватному каналу

RemotePrivateEndpointConnectionARMResource

Ресурс ARM удаленного подключения к частной конечной точке.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
name	string	Имя ресурса.
properties.ipAddresses	string[]	Частный IPAddresses, сопоставленный с удаленной частной конечной точкой
properties.privateEndpoint	ArmIdWrapper	PrivateEndpoint подключения к удаленной частной конечной точке
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	Состояние подключения к приватному каналу
properties.provisioningState	string
type	string	Тип ресурса.

Share via