Backend - Get

Ссылка

Service:: API Management

API Version:: 2022-08-01

Возвращает сведения о серверной части, указанной ее идентификатором.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
backendId	path	True	string	Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
serviceName	path	True	string	Имя службы Управление API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	BackendContract	Текст ответа содержит указанную сущность Backend. Headers ETag: string
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

BackendContract

Текст ответа содержит указанную сущность Backend.

Headers

ETag: string

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

ApiManagementGetBackend

Sample Request

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

/** Samples for Backend Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.json
     */
    /**
     * Sample code: ApiManagementGetBackend.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetBackend(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.backends().getWithResponse("rg1", "apimService1", "sfbackend", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_backend.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.backend.get(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="sfbackend",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.json
func ExampleBackendClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBackendClient().Get(ctx, "rg1", "apimService1", "sfbackend", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BackendContract = armapimanagement.BackendContract{
	// 	Name: to.Ptr("sfbackend"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend"),
	// 	Properties: &armapimanagement.BackendContractProperties{
	// 		Description: to.Ptr("Service Fabric Test App 1"),
	// 		Properties: &armapimanagement.BackendProperties{
	// 			ServiceFabricCluster: &armapimanagement.BackendServiceFabricClusterProperties{
	// 				ClientCertificateID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
	// 				ManagementEndpoints: []*string{
	// 					to.Ptr("https://somecluster.com")},
	// 					MaxPartitionResolutionRetries: to.Ptr[int32](5),
	// 					ServerX509Names: []*armapimanagement.X509CertificateName{
	// 						{
	// 							Name: to.Ptr("ServerCommonName1"),
	// 							IssuerCertificateThumbprint: to.Ptr("IssuerCertificateThumbprint1"),
	// 					}},
	// 				},
	// 			},
	// 			URL: to.Ptr("fabric:/mytestapp/mytestservice"),
	// 			Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the details of the backend specified by its identifier.
 *
 * @summary Gets the details of the backend specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.json
 */
async function apiManagementGetBackend() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "sfbackend";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.get(resourceGroupName, serviceName, backendId);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Определения

Имя	Описание
BackendAuthorizationHeaderCredentials	Сведения о заголовке авторизации.
BackendContract	Сведения о серверной части.
BackendCredentialsContract	Сведения об учетных данных, используемых для подключения к серверной части.
BackendProperties	Свойства, относящиеся к типу серверной части.
BackendProtocol	Серверный протокол связи.
BackendProxyContract	Сведения о серверном сервере WebProxy для использования в запросе к серверной части.
BackendServiceFabricClusterProperties	Свойства серверной части типа Service Fabric.
BackendTlsProperties	Свойства, управляющие проверкой сертификата TLS.
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ на ошибку.
X509CertificateName	Свойства сервера X509Names.

BackendAuthorizationHeaderCredentials

Сведения о заголовке авторизации.

Имя	Тип	Описание
parameter	string	Значение параметра проверки подлинности.
scheme	string	Имя схемы проверки подлинности.

BackendContract

Сведения о серверной части.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.credentials	BackendCredentialsContract	Свойства контракта учетных данных серверной части
properties.description	string	Описание серверной части.
properties.properties	BackendProperties	Контракт свойств серверной части
properties.protocol	BackendProtocol	Серверный протокол связи.
properties.proxy	BackendProxyContract	Свойства контракта внутреннего шлюза
properties.resourceId	string	URI управления ресурсом во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
properties.title	string	Название серверной части.
properties.tls	BackendTlsProperties	Свойства TLS серверной части
properties.url	string	URL-адрес среды выполнения серверной части.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

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

Имя	Тип	Описание
authorization	BackendAuthorizationHeaderCredentials	Проверка подлинности в заголовке авторизации
certificate	string[]	Список отпечатков сертификатов клиента. Игнорируется, если указаны идентификаторы сертификатов.
certificateIds	string[]	Список идентификаторов сертификатов клиента.
header	object	Описание параметра заголовка.
query	object	Описание параметра запроса.

BackendProperties

Свойства, относящиеся к типу серверной части.

Имя	Тип	Описание
serviceFabricCluster	BackendServiceFabricClusterProperties	Свойства кластера 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	X509CertificateName[]	Коллекция имен сертификатов Server X509

BackendTlsProperties

Свойства, управляющие проверкой сертификата TLS.

Имя	Тип	Значение по умолчанию	Описание
validateCertificateChain	boolean	True	Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого серверного узла.
validateCertificateName	boolean	True	Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого серверного узла.

ErrorFieldContract

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

Имя	Тип	Описание
code	string	Код ошибки уровня свойства.
message	string	Понятное представление ошибки на уровне свойств.
target	string	Имя свойства.

ErrorResponse

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

Имя	Тип	Описание
error.code	string	Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.
error.details	ErrorFieldContract[]	Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message	string	Читаемое представление ошибки.

X509CertificateName

Свойства сервера X509Names.

Имя	Тип	Описание
issuerCertificateThumbprint	string	Отпечаток для издателя сертификата.
name	string	Общее имя сертификата.

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

Backend - Get

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

ApiManagementGetBackend

Sample Request

Sample Response

Определения

BackendAuthorizationHeaderCredentials

BackendContract

BackendCredentialsContract

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

ErrorFieldContract

ErrorResponse

X509CertificateName

Дополнительные ресурсы