Authorization Server - Get

Serviço:

API Management

Versão da API:

2021-08-01

Obtém os detalhes do servidor de autorização especificados pelo identificador.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
authsid	path	True	string	Identificador do servidor de autorização. Padrão Regex: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Respostas

Name	Tipo	Description
200 OK	AuthorizationServerContract	Obtém os detalhes do servidor de autorização especificado. Não existem segredos incluídos. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementGetAuthorizationServer

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
AuthorizationMethod	Verbos HTTP suportados pelo ponto final de autorização. O GET tem de estar sempre presente. POST é opcional.
AuthorizationServerContract	Definições externas do servidor de autorização OAuth.
BearerTokenSendingMethod	Especifica o mecanismo através do qual o token de acesso é transmitido à API.
ClientAuthenticationMethod	Método de autenticação suportado pelo ponto final de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são transmitidos no corpo do pedido no formato application/x-www-form-urlencoded.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
GrantType	Forma de uma concessão de autorização, que o cliente utiliza para pedir o token de acesso.
TokenBodyParameterContract	OAuth adquire o parâmetro do corpo do pedido de token (www-url-form-encoded).

AuthorizationMethod

Verbos HTTP suportados pelo ponto final de autorização. O GET tem de estar sempre presente. POST é opcional.

Name	Tipo	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

Definições externas do servidor de autorização OAuth.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.authorizationEndpoint	string	Ponto final de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	Verbos HTTP suportados pelo ponto final de autorização. O GET tem de estar sempre presente. POST é opcional.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Especifica o mecanismo através do qual o token de acesso é transmitido à API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Método de autenticação suportado pelo ponto final de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são transmitidos no corpo do pedido no formato application/x-www-form-urlencoded.
properties.clientId	string	ID de cliente ou aplicação registado neste servidor de autorização.
properties.clientRegistrationEndpoint	string	Referência opcional a uma página onde é efetuado o registo de clientes ou aplicações para este servidor de autorização. Contém o URL absoluto para a entidade que está a ser referenciada.
properties.clientSecret	string	Segredo do cliente ou da aplicação registado neste servidor de autorização. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.
properties.defaultScope	string	Âmbito do token de acesso que vai ser pedido por predefinição. Pode ser substituído ao nível da API. Deve ser fornecido na forma de uma cadeia que contém valores delimitados pelo espaço.
properties.description	string	Descrição do servidor de autorização. Pode conter etiquetas de formatação HTML.
properties.displayName	string	Nome do servidor de autorização amigável.
properties.grantTypes	GrantType[]	Forma de uma concessão de autorização, que o cliente utiliza para pedir o token de acesso.
properties.resourceOwnerPassword	string	Opcionalmente, pode ser especificado quando o tipo de concessão de palavra-passe do proprietário do recurso é suportado por este servidor de autorização. Palavra-passe predefinida do proprietário do recurso.
properties.resourceOwnerUsername	string	Opcionalmente, pode ser especificado quando o tipo de concessão de palavra-passe do proprietário do recurso é suportado por este servidor de autorização. Nome de utilizador predefinido do proprietário do recurso.
properties.supportState	boolean	Se for verdadeiro, o servidor de autorização incluirá o parâmetro de estado do pedido de autorização para a respetiva resposta. O cliente pode utilizar o parâmetro de estado para aumentar a segurança do protocolo.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Parâmetros adicionais exigidos pelo ponto final do token deste servidor de autorização representados como uma matriz de objetos JSON com propriedades de cadeia de nome e valor, ou seja, {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	Ponto final do token OAuth. Contém o URI absoluto para a entidade que está a ser referenciada.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

Especifica o mecanismo através do qual o token de acesso é transmitido à API.

Name	Tipo	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

Método de autenticação suportado pelo ponto final de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são transmitidos no corpo do pedido no formato application/x-www-form-urlencoded.

Name	Tipo	Description
Basic	string	Método de Autenticação de Cliente Básico.
Body	string	Método de Autenticação baseado no corpo.

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

GrantType

Forma de uma concessão de autorização, que o cliente utiliza para pedir o token de acesso.

Name	Tipo	Description
authorizationCode	string	Fluxo de Concessão de Código de Autorização conforme descrito https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Fluxo de Concessão de Credenciais de Cliente conforme descrito https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Fluxo de Concessão de Código Implícito, conforme descrito https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword	string	Fluxo de Concessão de Palavra-passe do Proprietário do Recurso, conforme descrito https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth adquire o parâmetro do corpo do pedido de token (www-url-form-encoded).

Name	Tipo	Description
name	string	nome do parâmetro do corpo.
value	string	valor do parâmetro do corpo.