Workspace Group User - List

Servicio:

API Management

Versión de la API:

2024-05-01

Enumera una colección de entidades de usuario asociadas al grupo.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
groupId	path	True	string minLength: 1 maxLength: 256	Identificador de grupo. Debe ser único en la instancia actual del servicio API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador del área de trabajo. Debe ser único en la instancia actual del servicio API Management.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
$filter	query		string	| Campo | Uso | Operadores admitidos | Funciones admitidas | |-------------|-------------|-------------|-------------| | 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 | | email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | registrationDate | filter | ge, le, eq, ne, gt, lt | | | nota | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer (int32) minimum: 0	Número de registros que se van a omitir.
$top	query		integer (int32) minimum: 1	Número de registros que se van a devolver.

Respuestas

Nombre	Tipo	Description
200 OK	UserCollection	Enumera una colección de entidades de usuario asociadas al grupo.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementListWorkspaceGroupUsers

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for WorkspaceGroupUser List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListWorkspaceGroupUsers.json
     */
    /**
     * Sample code: ApiManagementListWorkspaceGroupUsers.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListWorkspaceGroupUsers(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.workspaceGroupUsers().list("rg1", "apimService1", "wks1", "57d2ef278aa04f0888cba3f3", 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_workspace_group_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.workspace_group_user.list(
        resource_group_name="rg1",
        service_name="apimService1",
        workspace_id="wks1",
        group_id="57d2ef278aa04f0888cba3f3",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListWorkspaceGroupUsers.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/ApiManagementListWorkspaceGroupUsers.json
func ExampleWorkspaceGroupUserClient_NewListPager() {
	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.NewWorkspaceGroupUserClient().NewListPager("rg1", "apimService1", "wks1", "57d2ef278aa04f0888cba3f3", &armapimanagement.WorkspaceGroupUserClientListOptions{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.UserCollection = armapimanagement.UserCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.UserContract{
		// 		{
		// 			Name: to.Ptr("armTemplateUser1"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/workspaces/groups/users"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1"),
		// 			Properties: &armapimanagement.UserContractProperties{
		// 				Identities: []*armapimanagement.UserIdentityContract{
		// 					{
		// 						ID: to.Ptr("user1@live.com"),
		// 						Provider: to.Ptr("Basic"),
		// 				}},
		// 				Note: to.Ptr("note for user 1"),
		// 				State: to.Ptr(armapimanagement.UserStateActive),
		// 				Email: to.Ptr("user1@live.com"),
		// 				FirstName: to.Ptr("user1"),
		// 				LastName: to.Ptr("lastname1"),
		// 				RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-31T18:54:41.447Z"); 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 user entities associated with the group.
 *
 * @summary Lists a collection of user entities associated with the group.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListWorkspaceGroupUsers.json
 */
async function apiManagementListWorkspaceGroupUsers() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const workspaceId = "wks1";
  const groupId = "57d2ef278aa04f0888cba3f3";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.workspaceGroupUser.list(
    resourceGroupName,
    serviceName,
    workspaceId,
    groupId,
  )) {
    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/ApiManagementListWorkspaceGroupUsers.json
// this example is just showing the usage of "WorkspaceGroupUser_List" 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 ServiceWorkspaceGroupResource created on azure
// for more information of creating ServiceWorkspaceGroupResource, please refer to the document of ServiceWorkspaceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string workspaceId = "wks1";
string groupId = "57d2ef278aa04f0888cba3f3";
ResourceIdentifier serviceWorkspaceGroupResourceId = ServiceWorkspaceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, workspaceId, groupId);
ServiceWorkspaceGroupResource serviceWorkspaceGroup = client.GetServiceWorkspaceGroupResource(serviceWorkspaceGroupResourceId);

// invoke the operation and iterate over the result
await foreach (ApiManagementUserResource item in serviceWorkspaceGroup.GetWorkspaceGroupUsersAsync())
{
    // 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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1",
      "type": "Microsoft.ApiManagement/service/workspaces/groups/users",
      "name": "armTemplateUser1",
      "properties": {
        "firstName": "user1",
        "lastName": "lastname1",
        "email": "user1@live.com",
        "state": "active",
        "registrationDate": "2017-05-31T18:54:41.447Z",
        "note": "note for user 1",
        "identities": [
          {
            "provider": "Basic",
            "id": "user1@live.com"
          }
        ]
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GroupContractProperties	Propiedades del contrato de grupo.
GroupType	Tipo de grupo.
UserCollection	Representación de la lista Usuarios paginados.
UserContract	Detalles del usuario.
UserIdentityContract	Detalles de la identidad del usuario.
UserState	Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de productos suscritos. El estado predeterminado es Activo.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GroupContractProperties

Object

Propiedades del contrato de grupo.

Nombre	Tipo	Description
builtIn	boolean	true si el grupo es uno de los tres grupos del sistema (administradores, desarrolladores o invitados); de lo contrario, false.
description	string maxLength: 1000	Descripción del grupo. Puede contener etiquetas de formato HTML.
displayName	string minLength: 1 maxLength: 300	Nombre del grupo.
externalId	string	En el caso de los grupos externos, esta propiedad contiene el identificador del grupo del proveedor de identidades externo, por ejemplo, para Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; de lo contrario, el valor es NULL.
type	GroupType	Tipo de grupo.

GroupType

Enumeración

Tipo de grupo.

Valor	Description
custom
external
system

UserCollection

Object

Representación de la lista Usuarios paginados.

Nombre	Tipo	Description
count	integer (int64)	Número total de recuento de registros en todas las páginas.
nextLink	string	Vínculo de página siguiente si existe.
value	UserContract[]	Valores de página.

UserContract

Object

Detalles del usuario.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nombre del recurso
properties.email	string		Dirección de correo electrónico.
properties.firstName	string		Nombre.
properties.groups	GroupContractProperties[]		La colección de grupos de usuarios forma parte de .
properties.identities	UserIdentityContract[]		Colección de identidades de usuario.
properties.lastName	string		Apellido.
properties.note	string		Nota opcional sobre un usuario establecido por el administrador.
properties.registrationDate	string (date-time)		Fecha de registro de usuario. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
properties.state	UserState	active	Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de productos suscritos. El estado predeterminado es Activo.
type	string		Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

UserIdentityContract

Object

Detalles de la identidad del usuario.

Nombre	Tipo	Description
id	string	Valor de identificador dentro del proveedor.
provider	string	Nombre del proveedor de identidades.

UserState

Enumeración

Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de productos suscritos. El estado predeterminado es Activo.

Valor	Description
active	El estado del usuario está activo.
blocked	El usuario está bloqueado. Los usuarios bloqueados no se pueden autenticar en el portal para desarrolladores ni llamar a la API.
deleted	Se cierra la cuenta de usuario. Se quitan todas las identidades y las entidades relacionadas.
pending	La cuenta de usuario está pendiente. Requiere confirmación de identidad antes de que se pueda activar.