Authorization Server - Get

Service:

API Management

API Version:

2022-08-01

Tanımlayıcısı tarafından belirtilen yetkilendirme sunucusunun ayrıntılarını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
authsid	path	True	string	Yetkilendirme sunucusunun tanımlayıcısı. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	AuthorizationServerContract	Belirtilen yetkilendirme sunucusunun ayrıntılarını alır. Gizli diziler dahil değildir. Headers ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementGetAuthorizationServer

Sample Request

HTTP

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

Java

/** Samples for AuthorizationServer Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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", 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

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/2022-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/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/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)},
	// 						UseInAPIDocumentation: to.Ptr(true),
	// 						UseInTestConsole: to.Ptr(false),
	// 					},
	// 				}
}

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/2022-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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer2",
  "properties": {
    "displayName": "test3",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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"
  }
}

Tanımlar

Name	Description
AuthorizationMethod	Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır.
AuthorizationServerContract	Dış OAuth yetkilendirme sunucusu ayarları.
BearerTokenSendingMethod	Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir.
ClientAuthenticationMethod	Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde application/x-www-form-urlencoded biçiminde geçirilir.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
GrantType	İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi.
TokenBodyParameterContract	OAuth belirteç isteği gövde parametresini (www-url-form-kodlanmış) alır.

AuthorizationMethod

Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır.

Name	Tür	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

Dış OAuth yetkilendirme sunucusu ayarları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.authorizationEndpoint	string	OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde application/x-www-form-urlencoded biçiminde geçirilir.
properties.clientId	string	Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği.
properties.clientRegistrationEndpoint	string	Bu yetkilendirme sunucusu için istemci veya uygulama kaydının gerçekleştirildiği sayfaya isteğe bağlı başvuru. Başvurulmakta olan varlığın mutlak URL'sini içerir.
properties.clientSecret	string	Bu yetkilendirme sunucusuna kaydedilmiş istemci veya uygulama gizli dizisi. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın.
properties.defaultScope	string	Varsayılan olarak istenecek erişim belirteci kapsamı. API düzeyinde geçersiz kılınabilir. Boşlukla ayrılmış değerler içeren bir dize biçiminde sağlanmalıdır.
properties.description	string	Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir.
properties.displayName	string	Kullanıcı dostu yetkilendirme sunucusu adı.
properties.grantTypes	GrantType[]	İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi.
properties.resourceOwnerPassword	string	Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi parolası.
properties.resourceOwnerUsername	string	Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi kullanıcı adı.
properties.supportState	boolean	True ise yetkilendirme sunucusu, yetkilendirme isteğinden yanıtına durum parametresini ekler. İstemci, protokol güvenliğini artırmak için durum parametresini kullanabilir.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Bu yetkilendirme sunucusunun belirteç uç noktası için gereken ek parametreler, ad ve değer dizesi özelliklerine sahip bir JSON nesneleri dizisi olarak temsil edilir. Örneğin, {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir.
properties.useInApiDocumentation	boolean	Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur.
properties.useInTestConsole	boolean	Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir.

Name	Tür	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde application/x-www-form-urlencoded biçiminde geçirilir.

Name	Tür	Description
Basic	string	Temel İstemci Kimlik Doğrulama yöntemi.
Body	string	Gövde tabanlı Kimlik Doğrulama yöntemi.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilen gösterimi.

GrantType

İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi.

Name	Tür	Description
authorizationCode	string	Yetkilendirme Kodu Verme akışı açıklandığı https://tools.ietf.org/html/rfc6749#section-4.1gibi.
clientCredentials	string	İstemci Kimlik Bilgileri Akışına açıklandığı https://tools.ietf.org/html/rfc6749#section-4.4gibi verin.
implicit	string	açıklandığı https://tools.ietf.org/html/rfc6749#section-4.2gibi örtük Kod Verme akışı.
resourceOwnerPassword	string	Kaynak Sahibi Parola Verme akışı açıklandığı https://tools.ietf.org/html/rfc6749#section-4.3gibi.

TokenBodyParameterContract

OAuth belirteç isteği gövde parametresini (www-url-form-kodlanmış) alır.

Name	Tür	Description
name	string	gövde parametresi adı.
value	string	body parametre değeri.