Users - List By Lab

Ссылка

Служба:: Lab Services

Версия API:: 2023-06-07

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07&$filter={$filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
labName	path	True	string	Имя лаборатории, которая однозначно идентифицирует ее в содержательном плане лаборатории. Используется в URI ресурсов.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.
$filter	query		string	Фильтр, применяемый к операции.

Ответы

Имя	Тип	Описание
200 OK	PagedUsers	Запрос выполнен успешно; ответ содержит всех пользователей для данной лаборатории.
Other Status Codes	ErrorResponse	Ответ об ошибке по умолчанию.

Примеры

listUser

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

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/users?api-version=2023-06-07

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

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

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/users/testuser",
      "name": "default",
      "type": "Microsoft.LabServices/User",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "displayName": "Test User",
        "email": "testuser@contoso.com",
        "registrationState": "Registered",
        "invitationState": "Sent",
        "totalUsage": "PT10H",
        "additionalUsageQuota": "PT10H"
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
InvitationState	Состояние приглашения пользователя лаборатории.
PagedUsers	Страничный список пользователей.
ProvisioningState	Текущее состояние подготовки ресурса пользователя.
RegistrationState	Состояние регистрации лаборатории пользователя.
ResourceOperationError	Сведения об ошибке последнего сбоя операции в этом ресурсе
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
User	Пользователь лаборатории, который может зарегистрироваться и использовать виртуальные машины в лаборатории.

createdByType

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

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

InvitationState

Состояние приглашения пользователя лаборатории.

Имя	Тип	Описание
Failed	string	При отправке приглашения произошла ошибка.
NotSent	string	Приглашение не отправлено.
Sending	string	В настоящее время отправляется приглашение.
Sent	string	Приглашение успешно отправлено.

PagedUsers

Страничный список пользователей.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов изображения.
value	User[]	Страница массива результатов пользователя.

ProvisioningState

Текущее состояние подготовки ресурса пользователя.

Имя	Тип	Описание
Creating	string	Ресурс находится в процессе создания.
Deleting	string	Ресурс находится в процессе удаления.
Failed	string	Предыдущая операция с ресурсом завершилась сбоем, оставив ресурс в неработоспособном состоянии.
Locked	string	Ресурс заблокирован, а изменения в настоящее время блокируются. Это может быть связано с обслуживанием или запланированной операцией. После завершения операции блокировки состояние вернется к успешному.
Succeeded	string	Ресурс находится в работоспособном состоянии после создания или обновления.
Updating	string	К ресурсу применяются новые значения свойств.

RegistrationState

Состояние регистрации лаборатории пользователя.

Имя	Тип	Описание
NotRegistered	string	Пользователь зарегистрировался в лаборатории.
Registered	string	Пользователь еще не зарегистрирован в лаборатории.

ResourceOperationError

Сведения об ошибке последнего сбоя операции в этом ресурсе

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

systemData

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

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

User

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.additionalUsageQuota	string	Время квоты использования, которое пользователь получает в дополнение к квоте использования лаборатории.
properties.displayName	string	Отображаемое имя пользователя, например полное имя пользователя.
properties.email	string	Адрес электронной почты пользователя.
properties.invitationSent	string	Дата и время отправки пользователю сообщения с приглашением.
properties.invitationState	InvitationState	Состояние сообщения приглашения для пользователя.
properties.provisioningState	ProvisioningState	Текущее состояние подготовки ресурса пользователя.
properties.registrationState	RegistrationState	Состояние регистрации пользователя в лаборатории.
properties.resourceOperationError	ResourceOperationError	Сведения об ошибке последней операции, выполненной в плане лаборатории.
properties.totalUsage	string	Как долго пользователь использует свои виртуальные машины в этом задании.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса пользователя.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

Поделиться через