Authorization Server - Get

Service:

API Management

Version d'API:

2021-08-01

Obtient les détails du serveur d’autorisation spécifiés par son identificateur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
authsid	path	True	string	Identificateur du serveur d’autorisation. Modèle d’expression régulière: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string	Nom du service Gestion des API. Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Réponses

Nom	Type	Description
200 OK	AuthorizationServerContract	Obtient les détails du serveur d’autorisation spécifié. Aucun secret inclus. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGetAuthorizationServer

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
AuthorizationMethod	Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.
AuthorizationServerContract	Paramètres du serveur d’autorisation OAuth externe.
BearerTokenSendingMethod	Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.
ClientAuthenticationMethod	Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la demande au format application/x-www-form-urlencoded.
ErrorFieldContract	Contrat champ d’erreur.
ErrorResponse	Réponse d’erreur.
GrantType	Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.
TokenBodyParameterContract	OAuth acquire token request body parameter (www-url-form-encoded).

AuthorizationMethod

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

Nom	Type	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

Paramètres du serveur d’autorisation OAuth externe.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.authorizationEndpoint	string	Point de terminaison d'autorisation OAuth. Consultez http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la demande au format application/x-www-form-urlencoded.
properties.clientId	string	Id de client ou d'application inscrit auprès du serveur d'autorisation.
properties.clientRegistrationEndpoint	string	Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.
properties.clientSecret	string	Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété n’est pas renseignée sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
properties.defaultScope	string	Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.
properties.description	string	Description du serveur d'autorisation. Peut contenir des balises au format HTML.
properties.displayName	string	Nom du serveur d’autorisation convivial.
properties.grantTypes	GrantType[]	Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.
properties.resourceOwnerPassword	string	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.
properties.resourceOwnerUsername	string	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.
properties.supportState	boolean	Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, à savoir {"name » : « name value », « value » : « a value"}.
properties.tokenEndpoint	string	Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BearerTokenSendingMethod

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

Nom	Type	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la demande au format application/x-www-form-urlencoded.

Nom	Type	Description
Basic	string	Méthode d’authentification client de base.
Body	string	Méthode d’authentification basée sur le corps.

ErrorFieldContract

Contrat champ d’erreur.

Nom	Type	Description
code	string	Code d'erreur de niveau propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target	string	Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error.code	string	Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
error.details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message	string	Représentation contrôlable de visu de l’erreur.

GrantType

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

Nom	Type	Description
authorizationCode	string	Flux d’octroi de code d’autorisation comme décrit https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Flux d’octroi des informations d’identification du client comme décrit https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Flux d’octroi de code implicite comme décrit https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword	string	Flux d’octroi du mot de passe du propriétaire de la ressource comme décrit https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth acquire token request body parameter (www-url-form-encoded).

Nom	Type	Description
name	string	nom du paramètre body.
value	string	valeur du paramètre body.