Students - List

Servicio:

Education

Versión de la API:

2021-12-01-preview

Obtenga una lista de detalles sobre los alumnos asociados al laboratorio especificado.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?api-version=2021-12-01-preview

Con parámetros opcionales:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?includeDeleted={includeDeleted}&api-version=2021-12-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountName	path	True	string	Identificador que identifica de forma única una cuenta de facturación.
billingProfileName	path	True	string	Identificador que identifica de forma única un perfil de facturación.
invoiceSectionName	path	True	string	Identificador que identifica de forma única una sección de factura.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2021-12-01-preview
includeDeleted	query		boolean	Se puede usar para mostrar elementos eliminados.

Respuestas

Nombre	Tipo	Description
200 OK	StudentListResult	Detalles del alumno.
Other Status Codes	ErrorResponseBody	Describe el error si la operación no se realiza correctamente.

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

StudentList

Solicitud de ejemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?api-version=2021-12-01-preview

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}",
      "name": "{studentAlias}",
      "type": "Microsoft.Education/Students",
      "properties": {
        "firstName": "test",
        "lastName": "user",
        "email": "test@contoso.com",
        "role": "Student",
        "budget": {
          "currency": "USD",
          "value": 100
        },
        "subscriptionId": "000000000-0000-0000-0000-00000000000000",
        "expirationDate": "2022-11-09T21:43:54.161Z",
        "status": "Active",
        "effectiveDate": "2021-11-09T21:43:54.161Z",
        "subscriptionAlias": "000000000-0000-0000-0000-00000000000000",
        "subscriptionInviteLastSentDate": "2021-11-09T21:43:54.161Z"
      }
    }
  ]
}

Definiciones

Nombre	Description
Amount	Cantidad.
createdByType	Tipo de identidad que creó el recurso.
ErrorResponse	Describe el formato de respuesta de error.
ErrorResponseBody	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
Student Lab Status	Estado del laboratorio de alumnos
Student role	Rol de estudiante
StudentDetails	Detalles del alumno.
StudentListResult	Lista de alumnos.
systemData	Metadatos relativos a la creación y última modificación del recurso.

Amount

Object

Cantidad.

Nombre	Tipo	Description
currency	string	Tipo de moneda que se usa para el valor.
value	number	Valor de cantidad.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Describe el formato de respuesta de error.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponseBody

Object

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorResponse	Detalles del error.

Student Lab Status

Enumeración

Estado del laboratorio de alumnos

Valor	Description
Active
Disabled
Expired
Pending
Deleted

Student role

Enumeración

Rol de estudiante

Valor	Description
Student
Admin

StudentDetails

Object

Detalles del alumno.

Nombre	Tipo	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.budget	Amount	Presupuesto para estudiantes
properties.effectiveDate	string (date-time)	Fecha en que se agregó el alumno al laboratorio
properties.email	string	Correo electrónico de alumno
properties.expirationDate	string (date-time)	Fecha en que este alumno está establecido para expirar desde el laboratorio.
properties.firstName	string	Nombre
properties.lastName	string	Apellido
properties.role	Student role	Rol de estudiante
properties.status	Student Lab Status	Estado del laboratorio de alumnos
properties.subscriptionAlias	string	Alias de suscripción
properties.subscriptionId	string	Id. de suscripción
properties.subscriptionInviteLastSentDate	string (date-time)	fecha de última envío de invitación de suscripción
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

StudentListResult

Object

Lista de alumnos.

Nombre	Tipo	Description
nextLink	string	Vínculo (url) a la página siguiente de resultados.
value	StudentDetails[]	Lista de alumnos.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.