Enumerar miembros de una clase educationClass

Espacio de nombres: microsoft.graph

Recupera los miembros educationUser de una clase educationClass.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	❌	❌	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	EduRoster.ReadBasic	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	EduRoster.Read.All	EduRoster.ReadWrite.All, Member.Read.Hidden

Nota:

Tenga en cuenta que si se usa el token delegado, los miembros solo pueden ver información sobre sus propias clases.

Solicitud HTTP

GET /education/classes/{id}/members

Parámetros de consulta opcionales

Este método es compatible con los parámetros de consulta de OData para ayudar a personalizar la respuesta, incluyendo $search, $count, y $filter.

Cuando se agregan o actualizan elementos para este recurso, se indexan específicamente para usarse con los parámetros de consulta $count y $search. Puede producirse un leve retraso entre el momento en que se agrega o se actualiza un elemento y el momento en que está disponible en el índice.

Para más información sobre las opciones de consulta de OData, consulte Parámetros de consulta de OData.

Encabezados de solicitud

Encabezado	Valor
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y una colección de objetos educationUser en el cuerpo de la respuesta.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

HTTP

GET https://graph.microsoft.com/v1.0/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/members

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Classes["{educationClass-id}"].Members.GetAsync();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc education classes members list --education-class-id {educationClass-id}

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



members, err := graphClient.Education().Classes().ByEducationClassId("educationClass-id").Members().Get(context.Background(), nil)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EducationUserCollectionResponse result = graphClient.education().classes().byEducationClassId("{educationClass-id}").members().get();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let members = await client.api('/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/members')
	.get();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->education()->classes()->byEducationClassId('educationClass-id')->members()->get()->wait();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Education

Get-MgEducationClassMember -EducationClassId $educationClassId

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.education.classes.by_education_class_id('educationClass-id').members.get()

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.educationUser)",
  "value": [
    {
      "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
      "accountEnabled": true,
      "displayName": "Adele Vance",
      "givenName": "Adele",
      "surname": "Vance",
      "userPrincipalName": "AdeleV@contoso.com",
      "userType": "Member",
      "primaryRole": "teacher",
      "onPremisesInfo": {
        "immutableId": null
      },
      "teacher": {}
    },
    {
      "id": "b66ecf79-a093-4d51-86e0-efcc4531f37a",
      "accountEnabled": true,
      "displayName": "Christie Cline",
      "givenName": "Christie",
      "surname": "Cline",
      "userPrincipalName": "ChristieC@contoso.com",
      "userType": "Member",
      "primaryRole": "student",
      "onPremisesInfo": {
        "immutableId": null
      },
      "student": {}
    },
    {
      "id": "f5289423-7233-4d60-831a-fe107a8551cc",
      "accountEnabled": true,
      "displayName": "Ben Walters",
      "givenName": "Ben",
      "surname": "Walters",
      "userPrincipalName": "BenW@contoso.com",
      "userType": "Member",
      "primaryRole": "student",
      "onPremisesInfo": {
        "immutableId": null
      },
      "student": {}
    },
    {
      "id": "48d31887-5fad-4d73-a9f5-3c356e68a038",
      "accountEnabled": true,
      "displayName": "Megan Bowen",
      "givenName": "Megan",
      "surname": "Bowen",
      "userPrincipalName": "MeganB@contoso.com",
      "userType": "Member",
      "primaryRole": "teacher",
      "onPremisesInfo": {
        "immutableId": null
      },
      "teacher": {}
    },
    {
      "id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755",
      "accountEnabled": true,
      "displayName": "Allan Deyoung",
      "givenName": "Allan",
      "surname": "Deyoung",
      "userPrincipalName": "AllanD@contoso.com",
      "userType": "Member",
      "primaryRole": "student",
      "onPremisesInfo": {
        "immutableId": null
      },
      "student": {}
    }
  ]
}