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 매개 변수

Name	In(다음 안에)	필수	형식	Description
authsid	path	True	string	권한 부여 서버의 식별자입니다. regex 패턴: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	리소스 그룹의 이름.
serviceName	path	True	string	API Management 서비스의 이름입니다. regex 패턴: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

응답

Name	형식	Description
200 OK	AuthorizationServerContract	지정된 권한 부여 서버의 세부 정보를 가져옵니다. 비밀이 포함되어 있지 않습니다. 헤더 ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementGetAuthorizationServer

샘플 요청

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

정의

Name	Description
AuthorizationMethod	권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.
AuthorizationServerContract	외부 OAuth 권한 부여 서버 설정.
BearerTokenSendingMethod	액세스 토큰을 API로 전달하는 메커니즘을 지정합니다.
ClientAuthenticationMethod	이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.
ErrorFieldContract	오류 필드 계약입니다.
ErrorResponse	오류 응답.
GrantType	클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.
TokenBodyParameterContract	OAuth는 토큰 요청 본문 매개 변수(www-url-form-encoded)를 획득합니다.

AuthorizationMethod

권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.

Name	형식	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

외부 OAuth 권한 부여 서버 설정.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /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[]	이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.
properties.clientId	string	이 권한 부여 서버와 함께 등록되는 클라이언트 또는 앱 ID입니다.
properties.clientRegistrationEndpoint	string	이 권한 부여 서버에 대한 클라이언트 또는 앱 등록을 수행하는 페이지의 선택적 참조입니다. 참조되는 엔터티에 대한 절대 URL을 포함합니다.
properties.clientSecret	string	이 권한 부여 서버와 함께 등록되는 클라이언트 또는 앱 암호입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
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로 전달하는 메커니즘을 지정합니다.

Name	형식	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.

Name	형식	Description
Basic	string	기본 클라이언트 인증 방법입니다.
Body	string	본문 기반 인증 방법입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

GrantType

클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.

Name	형식	Description
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	형식	Description
name	string	body 매개 변수 이름입니다.
value	string	body 매개 변수 값입니다.