Authorization Server - Get

Ссылка

Служба:: API Management

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
authsid	path	True	string	Идентификатор сервера авторизации. Шаблон регулярного выражения: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	Имя группы ресурсов.
serviceName	path	True	string	Имя службы Управление API. Шаблон регулярного выражения: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Ответы

Имя

Тип

Описание

200 OK

AuthorizationServerContract

Возвращает сведения об указанном сервере авторизации. Секреты не включены.

Заголовки

ETag: string

Other Status Codes

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

ApiManagementGetAuthorizationServer

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

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

import com.azure.core.util.Context;

/** Samples for AuthorizationServer Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetAuthorizationServer.json
     */
    /**
     * Sample code: ApiManagementGetAuthorizationServer.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetAuthorizationServer(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.authorizationServers().getWithResponse("rg1", "apimService1", "newauthServer2", 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_authorization_server.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.authorization_server.get(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer2",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetAuthorizationServer.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/ApiManagementGetAuthorizationServer.json
func ExampleAuthorizationServerClient_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.NewAuthorizationServerClient().Get(ctx, "rg1", "apimService1", "newauthServer2", 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.AuthorizationServerContract = armapimanagement.AuthorizationServerContract{
	// 	Name: to.Ptr("newauthServer2"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/authorizationServers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2"),
	// 	Properties: &armapimanagement.AuthorizationServerContractProperties{
	// 		Description: to.Ptr("test server"),
	// 		AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
	// 			to.Ptr(armapimanagement.AuthorizationMethodGET)},
	// 			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
	// 				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
	// 				ClientAuthenticationMethod: []*armapimanagement.ClientAuthenticationMethod{
	// 					to.Ptr(armapimanagement.ClientAuthenticationMethodBasic)},
	// 					DefaultScope: to.Ptr("read write"),
	// 					ResourceOwnerPassword: to.Ptr("pwd"),
	// 					ResourceOwnerUsername: to.Ptr("un"),
	// 					SupportState: to.Ptr(true),
	// 					TokenEndpoint: to.Ptr("https://www.contoso.com/oauth2/token"),
	// 					AuthorizationEndpoint: to.Ptr("https://www.contoso.com/oauth2/auth"),
	// 					ClientID: to.Ptr("1"),
	// 					ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
	// 					DisplayName: to.Ptr("test3"),
	// 					GrantTypes: []*armapimanagement.GrantType{
	// 						to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
	// 						to.Ptr(armapimanagement.GrantTypeImplicit)},
	// 					},
	// 				}
}

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 authorization server specified by its identifier.
 *
 * @summary Gets the details of the authorization server specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetAuthorizationServer.json
 */
async function apiManagementGetAuthorizationServer() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer2";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.get(resourceGroupName, serviceName, authsid);
  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/ApiManagementGetAuthorizationServer.json
// this example is just showing the usage of "AuthorizationServer_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 ApiManagementAuthorizationServerResource
ApiManagementAuthorizationServerCollection collection = apiManagementService.GetApiManagementAuthorizationServers();

// invoke the operation
string authsid = "newauthServer2";
NullableResponse<ApiManagementAuthorizationServerResource> response = await collection.GetIfExistsAsync(authsid);
ApiManagementAuthorizationServerResource 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
    ApiManagementAuthorizationServerData 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/authorizationServers/newauthServer2",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer2",
  "properties": {
    "displayName": "test3",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "clientAuthenticationMethod": [
      "Basic"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Определения

Имя	Описание
AuthorizationMethod	HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.
AuthorizationServerContract	Параметры внешнего сервера авторизации OAuth.
BearerTokenSendingMethod	Определяет, с помощью какого механизма токен доступа передается API.
ClientAuthenticationMethod	Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и(или) Body. Если указан текст, учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ об ошибке.
GrantType	Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.
TokenBodyParameterContract	Параметр текста запроса на получение маркера OAuth (www-url-form-encoded).

AuthorizationMethod

HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.

Имя	Тип	Описание
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

Параметры внешнего сервера авторизации OAuth.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.authorizationEndpoint	string	Конечная точка авторизации по протоколу OAuth. См. раздел http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Определяет, с помощью какого механизма токен доступа передается API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и(или) Body. Если указан текст, учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.
properties.clientId	string	Идентификатор клиента или приложения, зарегистрированный для этого сервера авторизации.
properties.clientRegistrationEndpoint	string	Дополнительная ссылка на страницу, где выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес сущности, на которую имеется ссылка.
properties.clientSecret	string	Секрет клиента или приложения, зарегистрированный для этого сервера авторизации. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.
properties.defaultScope	string	Область маркера доступа , которая будет запрашиваться по умолчанию. Можно переопределить на уровне API. Необходимо предоставить в форме строки, содержащей разделенные пробелами значения.
properties.description	string	Описание сервера авторизации. Может содержать теги форматирования HTML.
properties.displayName	string	Понятное имя сервера авторизации.
properties.grantTypes	GrantType[]	Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.
properties.resourceOwnerPassword	string	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию.
properties.resourceOwnerUsername	string	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию.
properties.supportState	boolean	Если значение равно true, сервер авторизации будет включать параметр состояния из запроса авторизации в свой ответ. Клиент может использовать параметр состояния для повышения безопасности протокола.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Дополнительные параметры, необходимые для конечной точки маркера этого сервера авторизации, представленные в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	Конечная точка токена OAuth. Содержит абсолютный URI сущности, на которую имеется ссылка.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

BearerTokenSendingMethod

Определяет, с помощью какого механизма токен доступа передается API.

Имя	Тип	Описание
authorizationHeader	string
query	string

ClientAuthenticationMethod

Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и(или) Body. Если указан текст, учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.

Имя	Тип	Описание
Basic	string	Метод обычной проверки подлинности клиента.
Body	string	Метод проверки подлинности на основе текста.

ErrorFieldContract

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

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

ErrorResponse

Ответ об ошибке.

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

GrantType

Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.

Имя	Тип	Описание
authorizationCode	string	Поток предоставления кода авторизации, как описано https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Поток предоставления учетных данных клиента, как описано https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Поток предоставления неявного кода, как описано https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword	string	Поток предоставления пароля владельца ресурса, как описано https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

Параметр текста запроса на получение маркера OAuth (www-url-form-encoded).

Имя	Тип	Описание
name	string	имя параметра body.
value	string	значение параметра body.