Students - List

Служба:

Education

Версия API:

2021-12-01-preview

Получите список сведений о учащихся, связанных с указанной лабораторией.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountName	path	True	string	Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.
billingProfileName	path	True	string	Идентификатор, который однозначно идентифицирует профиль выставления счетов.
invoiceSectionName	path	True	string	Идентификатор, который однозначно идентифицирует раздел счета.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия : 2021-12-01-preview
includeDeleted	query		boolean	Может использоваться для отображения удаленных элементов.

Ответы

Имя	Тип	Описание
200 OK	StudentListResult	Сведения о студенте.
Other Status Codes	ErrorResponseBody	Описывает ошибку, если операция не выполнена успешно.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

StudentList

Образец запроса

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

Пример ответа

Код состояния:

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"
      }
    }
  ]
}

Определения

Имя	Описание
Amount	Сумма.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorResponse	Описывает формат ответа на ошибку.
ErrorResponseBody	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.
Student Lab Status	Состояние лаборатории учащихся
Student role	Роль учащегося
StudentDetails	Сведения о студенте.
StudentListResult	Список учащихся.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

Amount

Object

Сумма.

Имя	Тип	Описание
currency	string	Тип валюты, используемой для значения.
value	number	Значение суммы.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Описывает формат ответа на ошибку.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponseBody

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorResponse	Сведения об ошибке.

Student Lab Status

Перечисление

Состояние лаборатории учащихся

Значение	Описание
Active
Disabled
Expired
Pending
Deleted

Student role

Перечисление

Роль учащегося

Значение	Описание
Student
Admin

StudentDetails

Object

Сведения о студенте.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.budget	Amount	Бюджет учащихся
properties.effectiveDate	string (date-time)	Дата добавления учащегося в лабораторию
properties.email	string	Электронная почта учащегося
properties.expirationDate	string (date-time)	Дата окончания срока действия учащегося из лаборатории.
properties.firstName	string	Имя
properties.lastName	string	Фамилия
properties.role	Student role	Роль учащегося
properties.status	Student Lab Status	Состояние лаборатории учащихся
properties.subscriptionAlias	string	Псевдоним подписки
properties.subscriptionId	string	идентификатор подписки;
properties.subscriptionInviteLastSentDate	string (date-time)	Дата последнего отправки приглашения на подписку
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

StudentListResult

Object

Список учащихся.

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	StudentDetails[]	Список учащихся.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.