Apis - Get

Ссылка

Служба:: API Management

Версия API:: 2021-08-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.
resourceGroupName	path	True	string	Имя группы ресурсов.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Ответы

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

Имя

Тип

Описание

200 OK

ApiContract

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

Заголовки

ETag: string

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementGetApiContract

ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

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

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

import com.azure.core.util.Context;

/** Samples for Api Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiContract.json
     */
    /**
     * Sample code: ApiManagementGetApiContract.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetApiContract(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apis().getWithResponse("rg1", "apimService1", "57d1f7558aa04f15146d9d8a", 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_api_contract.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.api.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="57d1f7558aa04f15146d9d8a",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiContract.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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiContract.json
func ExampleAPIClient_Get_apiManagementGetApiContract() {
	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.NewAPIClient().Get(ctx, "rg1", "apimService1", "57d1f7558aa04f15146d9d8a", 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.APIContract = armapimanagement.APIContract{
	// 	Name: to.Ptr("57d1f7558aa04f15146d9d8a"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"),
	// 	Properties: &armapimanagement.APIContractProperties{
	// 		APIType: to.Ptr(armapimanagement.APITypeSoap),
	// 		APIRevision: to.Ptr("1"),
	// 		IsCurrent: to.Ptr(true),
	// 		IsOnline: to.Ptr(true),
	// 		SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 			Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 			Query: to.Ptr("subscription-key"),
	// 		},
	// 		Path: to.Ptr("schulte"),
	// 		DisplayName: to.Ptr("Service"),
	// 		Protocols: []*armapimanagement.Protocol{
	// 			to.Ptr(armapimanagement.ProtocolHTTPS)},
	// 			ServiceURL: to.Ptr("https://api.plexonline.com/DataSource/Service.asmx"),
	// 		},
	// 	}
}

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 API specified by its identifier.
 *
 * @summary Gets the details of the API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiContract.json
 */
async function apiManagementGetApiContract() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "57d1f7558aa04f15146d9d8a";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.api.get(resourceGroupName, serviceName, apiId);
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiContract.json
// this example is just showing the usage of "Api_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiResource
ApiCollection collection = apiManagementService.GetApis();

// invoke the operation
string apiId = "57d1f7558aa04f15146d9d8a";
NullableResponse<ApiResource> response = await collection.GetIfExistsAsync(apiId);
ApiResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

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

Код состояния:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

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

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2021-08-01

import com.azure.core.util.Context;

/** Samples for Api Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiRevision.json
     */
    /**
     * Sample code: ApiManagementGetApiRevisionContract.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetApiRevisionContract(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apis().getWithResponse("rg1", "apimService1", "echo-api;rev=3", 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_api_revision_contract.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.api.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="echo-api;rev=3",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiRevision.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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiRevision.json
func ExampleAPIClient_Get_apiManagementGetApiRevisionContract() {
	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.NewAPIClient().Get(ctx, "rg1", "apimService1", "echo-api;rev=3", 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.APIContract = armapimanagement.APIContract{
	// 	Name: to.Ptr("echo-api;rev=3"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3"),
	// 	Properties: &armapimanagement.APIContractProperties{
	// 		APIRevision: to.Ptr("3"),
	// 		APIRevisionDescription: to.Ptr("fixed bug in contract"),
	// 		SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 			Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 			Query: to.Ptr("subscription-key"),
	// 		},
	// 		Path: to.Ptr("schulte"),
	// 		DisplayName: to.Ptr("Service"),
	// 		Protocols: []*armapimanagement.Protocol{
	// 			to.Ptr(armapimanagement.ProtocolHTTPS)},
	// 			ServiceURL: to.Ptr("https://api.plexonline.com/DataSource/Service.asmx"),
	// 		},
	// 	}
}

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 API specified by its identifier.
 *
 * @summary Gets the details of the API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiRevision.json
 */
async function apiManagementGetApiRevisionContract() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api;rev=3";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.api.get(resourceGroupName, serviceName, apiId);
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetApiRevision.json
// this example is just showing the usage of "Api_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiResource
ApiCollection collection = apiManagementService.GetApis();

// invoke the operation
string apiId = "echo-api;rev=3";
NullableResponse<ApiResource> response = await collection.GetIfExistsAsync(apiId);
ApiResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

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

Код состояния:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Определения

Имя	Описание
ApiContactInformation	Контактные данные API
ApiContract	Сведения об API.
ApiLicenseInformation	Сведения о лицензии API
ApiType	Тип API.
ApiVersionSetContractDetails	Набор версий API содержит общую конфигурацию для набора версий API, связанных с
AuthenticationSettingsContract	Параметры проверки подлинности API.
bearerTokenSendingMethods	Как отправить маркер на сервер.
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ на ошибку.
OAuth2AuthenticationSettingsContract	Сведения о параметрах проверки подлинности OAuth2 API.
OpenIdAuthenticationSettingsContract	Сведения о параметрах проверки подлинности OAuth2 API.
Protocol	Описывает, какие протоколы могут вызываться в этом API.
SubscriptionKeyParameterNamesContract	Сведения о именах параметров ключа подписки.

ApiContactInformation

Object

Контактные данные API

Имя	Тип	Описание
email	string	Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты
name	string	Идентификация имени контактного лица или организации
url	string	URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса

ApiContract

Object

Сведения об API.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.apiRevision	string minLength: 1 maxLength: 100	Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию
properties.apiRevisionDescription	string maxLength: 256	Описание редакции API.
properties.apiVersion	string maxLength: 100	Указывает идентификатор версии API, если API имеет версию
properties.apiVersionDescription	string maxLength: 256	Описание версии API.
properties.apiVersionSet	ApiVersionSetContractDetails	Сведения о наборе версий
properties.apiVersionSetId	string	Идентификатор ресурса для связанного ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Коллекция параметров проверки подлинности, включенных в этот API.
properties.contact	ApiContactInformation	Контактные данные API.
properties.description	string	Описание API. Может включать теги форматирования HTML.
properties.displayName	string minLength: 1 maxLength: 300	Имя API. Должно составлять от 1 до 300 символов.
properties.isCurrent	boolean	Указывает, является ли редакция API текущей редакцией API.
properties.isOnline	boolean	Указывает, доступна ли редакция API через шлюз.
properties.license	ApiLicenseInformation	Сведения о лицензии для API.
properties.path	string minLength: 0 maxLength: 400	Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
properties.protocols	Protocol[]	Описывает, какие протоколы могут вызываться в этом API.
properties.serviceUrl	string minLength: 0 maxLength: 2000	Абсолютный URL-адрес серверной службы, реализующего этот API. Не может превышать 2000 символов.
properties.sourceApiId	string	Идентификатор API исходного API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Протоколы, через которые предоставляется API.
properties.subscriptionRequired	boolean	Указывает, требуется ли api или подписка на продукт для доступа к API.
properties.termsOfServiceUrl	string	URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса.
properties.type	ApiType	Тип API.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

Сведения о лицензии API

Имя	Тип	Описание
name	string	Имя лицензии, используемое для API
url	string	URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате URL-адреса

ApiType

Перечисление

Тип API.

Значение	Описание
graphql
http
soap
websocket

ApiVersionSetContractDetails

Object

Набор версий API содержит общую конфигурацию для набора версий API, связанных с

Имя	Тип	Описание
description	string	Описание набора версий API.
id	string	Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий.
name	string	Отображаемое имя набора версий API.
versionHeaderName	string	Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение `header`.
versionQueryName	string	Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение `query`.
versioningScheme	enum: Header Query Segment	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

AuthenticationSettingsContract

Object

Параметры проверки подлинности API.

Имя	Тип	Описание
oAuth2	OAuth2AuthenticationSettingsContract	Параметры проверки подлинности OAuth2
openid	OpenIdAuthenticationSettingsContract	Параметры проверки подлинности OpenID Connect

bearerTokenSendingMethods

Перечисление

Как отправить маркер на сервер.

Значение	Описание
authorizationHeader	Маркер доступа передается в заголовке авторизации с помощью схемы носителя
query	Маркер доступа передается в качестве параметров запроса.

ErrorFieldContract

Object

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

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

ErrorResponse

Object

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

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

OAuth2AuthenticationSettingsContract

Object

Сведения о параметрах проверки подлинности OAuth2 API.

Имя	Тип	Описание
authorizationServerId	string	Идентификатор сервера авторизации OAuth.
scope	string	область операций.

OpenIdAuthenticationSettingsContract

Object

Сведения о параметрах проверки подлинности OAuth2 API.

Имя	Тип	Описание
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Как отправить маркер на сервер.
openidProviderId	string	Идентификатор сервера авторизации OAuth.

Protocol

Перечисление

Описывает, какие протоколы могут вызываться в этом API.

Значение	Описание
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

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

Имя	Тип	Описание
header	string	Имя заголовка ключа подписки.
query	string	Имя параметра строки запроса ключа подписки.

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

Apis - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

ApiManagementGetApiContract

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

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

ApiManagementGetApiRevisionContract

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

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

Определения

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorFieldContract

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

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