Identity Provider - List By Service

Service:

API Management

API Version:

2022-08-01

Elenca una raccolta di provider di identità configurata nell'istanza del servizio specificata.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders?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.

Risposte

Nome	Tipo	Descrizione
200 OK	IdentityProviderList	Elenca una raccolta di provider di identità.
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

ApiManagementListIdentityProviders

Sample Request

HTTP

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

Java

/** Samples for IdentityProvider ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListIdentityProviders.json
     */
    /**
     * Sample code: ApiManagementListIdentityProviders.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListIdentityProviders(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.identityProviders().listByService("rg1", "apimService1", 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_list_identity_providers.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.identity_provider.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/ApiManagementListIdentityProviders.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/ApiManagementListIdentityProviders.json
func ExampleIdentityProviderClient_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.NewIdentityProviderClient().NewListByServicePager("rg1", "apimService1", 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.IdentityProviderList = armapimanagement.IdentityProviderList{
		// 	Count: to.Ptr[int64](3),
		// 	Value: []*armapimanagement.IdentityProviderContract{
		// 		{
		// 			Name: to.Ptr("Google"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google"),
		// 			Properties: &armapimanagement.IdentityProviderContractProperties{
		// 				Type: to.Ptr(armapimanagement.IdentityProviderTypeGoogle),
		// 				ClientID: to.Ptr("googleId"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Aad"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad"),
		// 			Properties: &armapimanagement.IdentityProviderContractProperties{
		// 				Type: to.Ptr(armapimanagement.IdentityProviderTypeAAD),
		// 				AllowedTenants: []*string{
		// 					to.Ptr("samiraad.onmicrosoft.com")},
		// 					ClientID: to.Ptr("aadapplicationid"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("AadB2C"),
		// 				Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C"),
		// 				Properties: &armapimanagement.IdentityProviderContractProperties{
		// 					Type: to.Ptr(armapimanagement.IdentityProviderTypeAADB2C),
		// 					AllowedTenants: []*string{
		// 						to.Ptr("samirtestbc.onmicrosoft.com")},
		// 						SigninPolicyName: to.Ptr("B2C_1_Signin_Default"),
		// 						SignupPolicyName: to.Ptr("B2C_1_Signup_Default"),
		// 						ClientID: to.Ptr("aadb2clientId"),
		// 					},
		// 			}},
		// 		}
	}
}

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 Lists a collection of Identity Provider configured in the specified service instance.
 *
 * @summary Lists a collection of Identity Provider configured in the specified service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListIdentityProviders.json
 */
async function apiManagementListIdentityProviders() {
  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.identityProvider.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/identityProviders/Google",
      "type": "Microsoft.ApiManagement/service/identityProviders",
      "name": "Google",
      "properties": {
        "clientId": "googleId",
        "type": "google"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad",
      "type": "Microsoft.ApiManagement/service/identityProviders",
      "name": "Aad",
      "properties": {
        "clientId": "aadapplicationid",
        "type": "aad",
        "allowedTenants": [
          "samiraad.onmicrosoft.com"
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C",
      "type": "Microsoft.ApiManagement/service/identityProviders",
      "name": "AadB2C",
      "properties": {
        "clientId": "aadb2clientId",
        "type": "aadB2C",
        "allowedTenants": [
          "samirtestbc.onmicrosoft.com"
        ],
        "signupPolicyName": "B2C_1_Signup_Default",
        "signinPolicyName": "B2C_1_Signin_Default"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definizioni

Nome	Descrizione
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
IdentityProviderContract	Dettagli del provider di identità.
IdentityProviderList	Elenco di tutti i provider di identità configurati nell'istanza del servizio.
IdentityProviderType	Identificatore del tipo di provider di identità.

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.

IdentityProviderContract

Dettagli del provider di identità.

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.allowedTenants	string[]	Elenco dei tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory.
properties.authority	string	Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C.
properties.clientId	string	ID client dell'applicazione nel provider di identità esterno. Si tratta dell'ID app per Facebook account di accesso, ID client per l'account di accesso Google, ID app per Microsoft.
properties.clientLibrary	string	Libreria client da usare nel portale per sviluppatori. Si applica solo al provider di identità AAD e AAD B2C.
properties.clientSecret	string	Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per Facebook account di accesso, chiave API per l'account di accesso Google, chiave pubblica per Microsoft. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.passwordResetPolicyName	string	Nome del criterio di reimpostazione della password. Si applica solo al provider di identità AAD B2C.
properties.profileEditingPolicyName	string	Nome criterio di modifica del profilo. Si applica solo al provider di identità AAD B2C.
properties.signinPolicyName	string	Nome criteri di accesso. Si applica solo al provider di identità AAD B2C.
properties.signinTenant	string	TenantId da usare invece di Common durante l'accesso ad Active Directory
properties.signupPolicyName	string	Nome criteri di iscrizione. Si applica solo al provider di identità AAD B2C.
properties.type	IdentityProviderType	Identificatore del tipo di provider di identità.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IdentityProviderList

Elenco di tutti i provider di identità configurati nell'istanza del servizio.

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

IdentityProviderType

Identificatore del tipo di provider di identità.

Nome	Tipo	Descrizione
aad	string	Azure Active Directory come provider di identità.
aadB2C	string	Azure Active Directory B2C come provider di identità.
facebook	string	Facebook come provider di identità.
google	string	Google come provider di identità.
microsoft	string	Microsoft Live come provider di identità.
twitter	string	Twitter come provider di identità.