User - List By Service

Service:

API Management

Version d'API:

2024-05-01

Répertorie une collection d’utilisateurs inscrits dans l’instance de service spécifiée.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$filter	query		string	| Champ | Utilisation | Opérateurs pris en charge | Fonctions prises en charge | |-------------|-------------|-------------|-------------| | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | e-mail | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq | | | registrationDate | filter | ge, le, eq, ne, gt, lt | | | remarque | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | groupes | expand | | |
$skip	query		integer (int32) minimum: 0	Nombre d’enregistrements à ignorer.
$top	query		integer (int32) minimum: 1	Nombre d’enregistrements à retourner.
expandGroups	query		boolean	Groupe détaillé en réponse.

Réponses

Nom	Type	Description
200 OK	UserCollection	Répertorie une collection d’entités utilisateur.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementListUsers

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2024-05-01

Java

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

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_users.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.user.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/2024-05-01/examples/ApiManagementListUsers.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListUsers.json
func ExampleUserClient_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.NewUserClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.UserClientListByServiceOptions{Filter: nil,
		Top:          nil,
		Skip:         nil,
		ExpandGroups: 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.UserCollection = armapimanagement.UserCollection{
		// 	Count: to.Ptr[int64](3),
		// 	Value: []*armapimanagement.UserContract{
		// 		{
		// 			Name: to.Ptr("1"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/users"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"),
		// 			Properties: &armapimanagement.UserContractProperties{
		// 				Identities: []*armapimanagement.UserIdentityContract{
		// 					{
		// 						ID: to.Ptr("admin@live.com"),
		// 						Provider: to.Ptr("Azure"),
		// 				}},
		// 				State: to.Ptr(armapimanagement.UserStateActive),
		// 				Email: to.Ptr("admin@live.com"),
		// 				FirstName: to.Ptr("Administrator"),
		// 				LastName: to.Ptr(""),
		// 				RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-09-22T01:57:39.677Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("56eaec62baf08b06e46d27fd"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/users"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd"),
		// 			Properties: &armapimanagement.UserContractProperties{
		// 				Identities: []*armapimanagement.UserIdentityContract{
		// 					{
		// 						ID: to.Ptr("foo.bar.83@gmail.com"),
		// 						Provider: to.Ptr("Basic"),
		// 				}},
		// 				State: to.Ptr(armapimanagement.UserStateActive),
		// 				Email: to.Ptr("foo.bar.83@gmail.com"),
		// 				FirstName: to.Ptr("foo"),
		// 				LastName: to.Ptr("bar"),
		// 				RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-17T17:41:56.327Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("5931a75ae4bbd512a88c680b"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/users"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
		// 			Properties: &armapimanagement.UserContractProperties{
		// 				Identities: []*armapimanagement.UserIdentityContract{
		// 					{
		// 						ID: to.Ptr("*************"),
		// 						Provider: to.Ptr("Microsoft"),
		// 				}},
		// 				State: to.Ptr(armapimanagement.UserStateActive),
		// 				Email: to.Ptr("foobar@outlook.com"),
		// 				FirstName: to.Ptr("foo"),
		// 				LastName: to.Ptr("bar"),
		// 				RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-02T17:58:50.357Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists a collection of registered users in the specified service instance.
 *
 * @summary Lists a collection of registered users in the specified service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListUsers.json
 */
async function apiManagementListUsers() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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 (const item of client.user.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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListUsers.json
// this example is just showing the usage of "User_ListByService" 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 = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementUserResource
ApiManagementUserCollection collection = apiManagementService.GetApiManagementUsers();

// invoke the operation and iterate over the result
await foreach (ApiManagementUserResource item in collection.GetAllAsync())
{
    // the variable item 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
    UserContractData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "1",
      "properties": {
        "firstName": "Administrator",
        "lastName": "",
        "email": "admin@live.com",
        "state": "active",
        "registrationDate": "2015-09-22T01:57:39.677Z",
        "identities": [
          {
            "provider": "Azure",
            "id": "admin@live.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "56eaec62baf08b06e46d27fd",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foo.bar.83@gmail.com",
        "state": "active",
        "registrationDate": "2016-03-17T17:41:56.327Z",
        "identities": [
          {
            "provider": "Basic",
            "id": "foo.bar.83@gmail.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "5931a75ae4bbd512a88c680b",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foobar@outlook.com",
        "state": "active",
        "registrationDate": "2017-06-02T17:58:50.357Z",
        "identities": [
          {
            "provider": "Microsoft",
            "id": "*************"
          }
        ]
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GroupContractProperties	Propriétés du contrat de groupe.
GroupType	Type de groupe.
UserCollection	Représentation de liste des utilisateurs paginés.
UserContract	Détails de l’utilisateur.
UserIdentityContract	Détails de l’identité de l’utilisateur.
UserState	État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GroupContractProperties

Object

Propriétés du contrat de groupe.

Nom	Type	Description
builtIn	boolean	true si le groupe est l’un des trois groupes système (administrateurs, développeurs ou invités) ; sinon false.
description	string maxLength: 1000	Description du groupe. Peut contenir des balises de mise en forme HTML.
displayName	string minLength: 1 maxLength: 300	Nom du groupe.
externalId	string	Pour les groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; sinon, la valeur est Null.
type	GroupType	Type de groupe.

GroupType

Énumération

Type de groupe.

Valeur	Description
custom
external
system

UserCollection

Object

Représentation de liste des utilisateurs paginés.

Nom	Type	Description
count	integer (int64)	Nombre total d’enregistrements sur toutes les pages.
nextLink	string	Lien de page suivant le cas échéant.
value	UserContract[]	Valeurs de page.

UserContract

Object

Détails de l’utilisateur.

Nom	Type	Valeur par défaut	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.email	string		Adresse courriel.
properties.firstName	string		Prénom.
properties.groups	GroupContractProperties[]		La collection d’utilisateurs de groupes fait partie intégrante.
properties.identities	UserIdentityContract[]		Collection d’identités utilisateur.
properties.lastName	string		Nom.
properties.note	string		Remarque facultative sur un utilisateur défini par l’administrateur.
properties.registrationDate	string (date-time)		Date de l’inscription de l’utilisateur. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
properties.state	UserState	active	État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

UserIdentityContract

Object

Détails de l’identité de l’utilisateur.

Nom	Type	Description
id	string	Valeur d’identificateur au sein du fournisseur.
provider	string	Nom du fournisseur d’identité.

UserState

Énumération

État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.

Valeur	Description
active	L’état utilisateur est actif.
blocked	L’utilisateur est bloqué. Les utilisateurs bloqués ne peuvent pas s’authentifier sur le portail des développeurs ou appeler l’API.
deleted	Le compte d’utilisateur est fermé. Toutes les identités et entités associées sont supprimées.
pending	Le compte d’utilisateur est en attente. Nécessite la confirmation de l’identité avant de pouvoir être rendue active.