Authorization Server - List By Service

Riferimento

Service:: API Management

API Version:: 2022-08-01

Elenca una raccolta di server di autorizzazione definiti all'interno di un'istanza del servizio.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName	path	True	string	Nome del servizio di Gestione API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$filter	query		string	\| Campo \| Utilizzo \| Operatori supportati \| Funzioni supportate \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Numero di record da ignorare.
$top	query		integer int32	Numero di record da restituire.

Risposte

Nome	Tipo	Descrizione
200 OK	AuthorizationServerCollection	Raccolta delle entità del server di autorizzazione per l'istanza del servizio Gestione API specificata.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementListAuthorizationServers

Sample Request

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

/** Samples for AuthorizationServer ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListAuthorizationServers.json
     */
    /**
     * Sample code: ApiManagementListAuthorizationServers.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListAuthorizationServers(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .authorizationServers()
            .listByService("rg1", "apimService1", null, null, null, 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

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_list_authorization_servers.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.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListAuthorizationServers.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

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/ApiManagementListAuthorizationServers.json
func ExampleAuthorizationServerClient_NewListByServicePager() {
	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)
	}
	pager := clientFactory.NewAuthorizationServerClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.AuthorizationServerClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AuthorizationServerCollection = armapimanagement.AuthorizationServerCollection{
		// 	Value: []*armapimanagement.AuthorizationServerContract{
		// 		{
		// 			Name: to.Ptr("newauthServer"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/authorizationServers"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer"),
		// 			Properties: &armapimanagement.AuthorizationServerContractProperties{
		// 				Description: to.Ptr("test server"),
		// 				AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
		// 					to.Ptr(armapimanagement.AuthorizationMethodGET)},
		// 					BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
		// 						to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
		// 						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("test2"),
		// 						GrantTypes: []*armapimanagement.GrantType{
		// 							to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
		// 							to.Ptr(armapimanagement.GrantTypeImplicit)},
		// 							UseInAPIDocumentation: to.Ptr(false),
		// 							UseInTestConsole: to.Ptr(true),
		// 						},
		// 					},
		// 					{
		// 						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

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of authorization servers defined within a service instance.
 *
 * @summary Lists a collection of authorization servers defined within a service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListAuthorizationServers.json
 */
async function apiManagementListAuthorizationServers() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.authorizationServer.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
      "type": "Microsoft.ApiManagement/service/authorizationServers",
      "name": "newauthServer",
      "properties": {
        "displayName": "test2",
        "useInTestConsole": true,
        "useInApiDocumentation": false,
        "description": "test server",
        "clientRegistrationEndpoint": "https://www.contoso.com/apps",
        "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
        "authorizationMethods": [
          "GET"
        ],
        "tokenEndpoint": "https://www.contoso.com/oauth2/token",
        "supportState": true,
        "defaultScope": "read write",
        "grantTypes": [
          "authorizationCode",
          "implicit"
        ],
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ],
        "clientId": "1",
        "resourceOwnerUsername": "un",
        "resourceOwnerPassword": "pwd"
      }
    },
    {
      "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"
      }
    }
  ],
  "nextLink": ""
}

Definizioni

Nome	Descrizione
AuthorizationMethod	Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.
AuthorizationServerCollection	Rappresentazione dell'elenco dei server di autorizzazione OAuth2 di paging.
AuthorizationServerContract	Impostazioni del server di autorizzazione OAuth esterne.
BearerTokenSendingMethod	Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.
ClientAuthenticationMethod	Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded.
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
GrantType	Forma di concessione di autorizzazione usata dal client per richiedere il token di accesso.
TokenBodyParameterContract	OAuth acquisisce il parametro del corpo della richiesta del token (www-url-form-encoded).

AuthorizationMethod

Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.

Nome	Tipo	Descrizione
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerCollection

Rappresentazione dell'elenco dei server di autorizzazione OAuth2 di paging.

Nome	Tipo	Descrizione
count	integer	Numero totale di conteggio record in tutte le pagine.
nextLink	string	Collegamento alla pagina successiva, se disponibile.
value	AuthorizationServerContract[]	Valori di pagina.

AuthorizationServerContract

Impostazioni del server di autorizzazione OAuth esterne.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.authorizationEndpoint	string	Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded.
properties.clientId	string	ID client o app registrato con il server di autorizzazione.
properties.clientRegistrationEndpoint	string	Riferimento facoltativo a una pagina in cui viene eseguita la registrazione del client o dell'app per questo server autorizzazione. Contiene l'URL assoluto dell'entità a cui si fa riferimento.
properties.clientSecret	string	Chiave privata dell'app o segreto client registrato con il server autorizzazione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.defaultScope	string	Ambito del token di accesso che verrà richiesto per impostazione predefinita. Può essere sottoposto a override a livello di API. Deve essere specificato sotto forma di stringa contenente valori delimitati da spazi.
properties.description	string	Descrizione del server autorizzazione. Può contenere tag di formattazione HTML.
properties.displayName	string	Nome del server di autorizzazione descrittivo.
properties.grantTypes	GrantType[]	Forma di concessione di autorizzazione usata dal client per richiedere il token di accesso.
properties.resourceOwnerPassword	string	Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Password del proprietario delle risorse predefinito.
properties.resourceOwnerUsername	string	Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Nome utente del proprietario delle risorse predefinito.
properties.supportState	boolean	Se true, il server di autorizzazione includerà il parametro di stato della richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per aumentare la sicurezza del protocollo.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Parametri aggiuntivi richiesti dall'endpoint del token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà della stringa nome e valore, ad esempio {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento.
properties.useInApiDocumentation	boolean	Se true, il server di autorizzazione verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene specificato alcun valore.
properties.useInTestConsole	boolean	Se true, il server di autorizzazione può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene specificato alcun valore.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

Nome	Tipo	Descrizione
authorizationHeader	string
query	string

ClientAuthenticationMethod

Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded.

Nome	Tipo	Descrizione
Basic	string	Metodo di autenticazione client di base.
Body	string	Metodo di autenticazione basato sul corpo.

ErrorFieldContract

Contratto campo di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

GrantType

Forma di concessione di autorizzazione usata dal client per richiedere il token di accesso.

Nome	Tipo	Descrizione
authorizationCode	string	Flusso di concessione del codice di autorizzazione come descritto https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Flusso di concessione delle credenziali client come descritto https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Flusso di concessione del codice implicito come descritto https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword	string	Flusso di concessione password del proprietario della risorsa come descritto https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth acquisisce il parametro del corpo della richiesta del token (www-url-form-encoded).

Nome	Tipo	Descrizione
name	string	nome del parametro body.
value	string	valore del parametro body.

Authorization Server - List By Service

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

ApiManagementListAuthorizationServers

Sample Request

Sample Response

Definizioni

AuthorizationMethod

AuthorizationServerCollection

AuthorizationServerContract

BearerTokenSendingMethod

ClientAuthenticationMethod

ErrorFieldContract

ErrorResponse

GrantType

TokenBodyParameterContract

Risorse aggiuntive