Backend - List By Service
Возвращает коллекцию серверных компонентов в указанном экземпляре службы.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?$filter={$filter}&$top={$top}&$skip={$skip}&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, используемая для данной операции. |
$filter
|
query |
string |
| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции | |
|
$skip
|
query |
integer int32 |
Количество записей, которые будут пропущены. |
|
$top
|
query |
integer int32 |
Количество возвращаемых записей. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Выводит коллекцию сущностей серверной части. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementListBackends
Образец запроса
Пример ответа
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "proxybackend",
"properties": {
"description": "description5308",
"url": "https://backendname2644/",
"protocol": "http",
"credentials": {
"query": {
"sv": [
"xx",
"bb",
"cc"
]
},
"header": {
"x-my-1": [
"val1",
"val2"
]
},
"authorization": {
"scheme": "Basic",
"parameter": "opensesma"
}
},
"proxy": {
"url": "http://192.168.1.1:8080",
"username": "Contoso\\admin",
"password": "<password>"
},
"tls": {
"validateCertificateChain": false,
"validateCertificateName": false
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "sfbackend",
"properties": {
"description": "Service Fabric Test App 1",
"url": "fabric:/mytestapp/mytestservice",
"protocol": "http",
"properties": {
"serviceFabricCluster": {
"managementEndpoints": [
"https://somecluster.com"
],
"clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"serverX509Names": [
{
"name": "ServerCommonName1",
"issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
}
],
"maxPartitionResolutionRetries": 5
}
}
}
}
],
"count": 2,
"nextLink": ""
}
Определения
Имя | Описание |
---|---|
Backend |
Сведения о заголовке авторизации. |
Backend |
Представление страничного списка серверной части. |
Backend |
Сведения о серверной части. |
Backend |
Сведения об учетных данных, используемых для подключения к серверной части. |
Backend |
Свойства, относящиеся к типу серверной части. |
Backend |
Серверный протокол связи. |
Backend |
Сведения о серверном сервере WebProxy для использования в запросе к серверной части. |
Backend |
Свойства серверной части типа Service Fabric. |
Backend |
Свойства, управляющие проверкой сертификата TLS. |
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
X509Certificate |
Свойства сервера X509Names. |
BackendAuthorizationHeaderCredentials
Сведения о заголовке авторизации.
Имя | Тип | Описание |
---|---|---|
parameter |
string |
Значение параметра проверки подлинности. |
scheme |
string |
Имя схемы проверки подлинности. |
BackendCollection
Представление страничного списка серверной части.
Имя | Тип | Описание |
---|---|---|
count |
integer |
Общее число записей на всех страницах. |
nextLink |
string |
Ссылка на следующую страницу при ее наличии. |
value |
Значения серверной части. |
BackendContract
Сведения о серверной части.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.credentials |
Свойства контракта учетных данных серверной части |
|
properties.description |
string |
Описание серверной части. |
properties.properties |
Контракт свойств серверной части |
|
properties.protocol |
Серверный протокол связи. |
|
properties.proxy |
Свойства контракта внутреннего шлюза |
|
properties.resourceId |
string |
URI управления ресурсом во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API. |
properties.title |
string |
Название серверной части. |
properties.tls |
Свойства TLS серверной части |
|
properties.url |
string |
URL-адрес среды выполнения серверной части. |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
Сведения об учетных данных, используемых для подключения к серверной части.
Имя | Тип | Описание |
---|---|---|
authorization |
Проверка подлинности в заголовке авторизации |
|
certificate |
string[] |
Список отпечатков сертификатов клиента. Игнорируется, если указаны идентификаторы сертификатов. |
certificateIds |
string[] |
Список идентификаторов сертификатов клиента. |
header |
object |
Описание параметра заголовка. |
query |
object |
Описание параметра запроса. |
BackendProperties
Свойства, относящиеся к типу серверной части.
Имя | Тип | Описание |
---|---|---|
serviceFabricCluster |
Свойства кластера Service Fabric серверной части |
BackendProtocol
Серверный протокол связи.
Имя | Тип | Описание |
---|---|---|
http |
string |
Серверная часть — это служба RESTful. |
soap |
string |
Серверная часть — это служба SOAP. |
BackendProxyContract
Сведения о серверном сервере WebProxy для использования в запросе к серверной части.
Имя | Тип | Описание |
---|---|---|
password |
string |
Пароль для подключения к серверу WebProxy |
url |
string |
Свойство AbsoluteUri сервера WebProxy, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса. |
username |
string |
Имя пользователя для подключения к серверу WebProxy |
BackendServiceFabricClusterProperties
Свойства серверной части типа Service Fabric.
Имя | Тип | Описание |
---|---|---|
clientCertificateId |
string |
Идентификатор сертификата клиента для конечной точки управления. |
clientCertificatethumbprint |
string |
Отпечаток сертификата клиента для конечной точки управления. Игнорируется при предоставлении идентификаторов сертификатов |
managementEndpoints |
string[] |
Конечная точка управления кластером. |
maxPartitionResolutionRetries |
integer |
Максимальное количество повторных попыток при попытке разрешения секции. |
serverCertificateThumbprints |
string[] |
Отпечатки сертификатов, которые служба управления кластером использует для обмена данными по протоколу TLS |
serverX509Names |
Коллекция имен сертификатов Server X509 |
BackendTlsProperties
Свойства, управляющие проверкой сертификата TLS.
Имя | Тип | Default value | Описание |
---|---|---|---|
validateCertificateChain |
boolean |
True |
Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого серверного узла. |
validateCertificateName |
boolean |
True |
Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого серверного узла. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Понятное представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
X509CertificateName
Свойства сервера X509Names.
Имя | Тип | Описание |
---|---|---|
issuerCertificateThumbprint |
string |
Отпечаток для издателя сертификата. |
name |
string |
Общее имя сертификата. |