Поделиться через


Private Endpoint Connection - List Private Link Resources

Возвращает ресурсы приватного канала.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources?api-version=2022-08-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName
path True

string

Имя службы Управление API.

Шаблон регулярного выражения: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

PrivateLinkResourceListResult

ОК

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

ApiManagementListPrivateLinkGroupResources

Образец запроса

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources?api-version=2022-08-01

Пример ответа

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway",
      "name": "Gateway",
      "type": "Microsoft.ApiManagement/service/privateLinkResources",
      "properties": {
        "groupId": "Gateway",
        "requiredMembers": [
          "Gateway"
        ],
        "requiredZoneNames": [
          "privateLink.azure-api.net"
        ]
      }
    }
  ]
}

Определения

Имя Описание
ErrorFieldContract

Контракт поля ошибки.

ErrorResponse

Ответ на ошибку.

PrivateLinkResource

Ресурс приватного канала

PrivateLinkResourceListResult

Список ресурсов приватного канала

ErrorFieldContract

Контракт поля ошибки.

Имя Тип Описание
code

string

Код ошибки уровня свойства.

message

string

Понятное представление ошибки на уровне свойств.

target

string

Имя свойства.

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
error.code

string

Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое представление ошибки.

PrivateLinkResource

Ресурс приватного канала

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

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.groupId

string

Идентификатор группы ресурсов приватного канала.

properties.requiredMembers

string[]

Ресурсу приватного канала требуются имена элементов.

properties.requiredZoneNames

string[]

Имя зоны DNS приватного канала приватного канала.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateLinkResourceListResult

Список ресурсов приватного канала

Имя Тип Описание
value

PrivateLinkResource[]

Массив ресурсов приватного канала