Private Endpoint Connection - List By Service
Выводит список всех подключений к частной конечной точке экземпляра службы Управление API.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Шаблон регулярного выражения: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementListPrivateEndpointConnections
Образец запроса
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections?api-version=2022-08-01
Пример ответа
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName2",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
}
}
}
]
}
Определения
Имя | Описание |
---|---|
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
Private |
Ресурс частной конечной точки. |
Private |
Ресурс подключения к частной конечной точке. |
Private |
Список подключений к частной конечной точке, связанных с указанной учетной записью хранения |
Private |
Текущее состояние подготовки. |
Private |
Состояние подключения к частной конечной точке. |
Private |
Коллекция сведений о состоянии соединения между потребителем службы и поставщиком. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Понятное представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
PrivateEndpoint
Ресурс частной конечной точки.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ARM для частной конечной точки |
PrivateEndpointConnection
Ресурс подключения к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.privateEndpoint |
Ресурс частной конечной точки. |
|
properties.privateLinkServiceConnectionState |
Коллекция сведений о состоянии соединения между потребителем службы и поставщиком. |
|
properties.provisioningState |
Состояние подготовки ресурса подключения к частной конечной точке. |
|
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionListResult
Список подключений к частной конечной точке, связанных с указанной учетной записью хранения
Имя | Тип | Описание |
---|---|---|
value |
Массив подключений к частной конечной точке |
PrivateEndpointConnectionProvisioningState
Текущее состояние подготовки.
Имя | Тип | Описание |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
Состояние подключения к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.
Имя | Тип | Описание |
---|---|---|
actionsRequired |
string |
Сообщение, указывающее, требуют ли изменения в поставщике услуг каких-либо обновлений для потребителя. |
description |
string |
Причина утверждения или отклонения подключения. |
status |
Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы. |