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 參數

名稱	位於	必要	類型	Description
authsid	path	True	string	授權伺服器的識別碼。 Regex 模式: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	資源群組的名稱。
serviceName	path	True	string	API 管理 服務的名稱。 Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

回應

名稱	類型	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

範圍

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

定義

名稱	Description
AuthorizationMethod	授權端點所支援的 HTTP 動詞命令。 GET 必須一律存在。 POST 是選擇性的。
AuthorizationServerContract	外部 OAuth 授權伺服器設定。
BearerTokenSendingMethod	指定用來將存取權杖傳遞至 API 的機制。
ClientAuthenticationMethod	此授權伺服器的權杖端點所支援的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。
ErrorFieldContract	錯誤欄位合約。
ErrorResponse	錯誤回應。
GrantType	用戶端用來要求存取令牌的授權授與形式。
TokenBodyParameterContract	OAuth 取得令牌要求本文參數 (www-url-form-encoded) 。

AuthorizationMethod

授權端點所支援的 HTTP 動詞命令。 GET 必須一律存在。 POST 是選擇性的。

名稱	類型	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

外部 OAuth 授權伺服器設定。

名稱	類型	Description
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。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。
properties.clientId	string	向此授權伺服器註冊的用戶端或應用程式識別碼。
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 的機制。

名稱	類型	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

此授權伺服器的權杖端點所支援的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。

名稱	類型	Description
Basic	string	基本客戶端驗證方法。
Body	string	本文型驗證方法。

ErrorFieldContract

錯誤欄位合約。

名稱	類型	Description
code	string	屬性層級錯誤碼。
message	string	人類可讀取的屬性層級錯誤表示法。
target	string	屬性名稱。

ErrorResponse

錯誤回應。

名稱	類型	Description
error.code	string	服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。
error.details	ErrorFieldContract[]	在驗證錯誤時，要求中傳送的無效欄位清單。
error.message	string	人類可閱讀的錯誤表示法。

GrantType

用戶端用來要求存取令牌的授權授與形式。

名稱	類型	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) 。

名稱	類型	Description
name	string	body 參數名稱。
value	string	body 參數值。