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 minLength: 1 maxLength: 100	Имя лаборатории, которая однозначно идентифицирует ее внутри содержащего плана лаборатории. Используется в URI ресурсов.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия 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": "[email protected]",
        "registrationState": "Registered",
        "invitationState": "Sent",
        "totalUsage": "PT10H",
        "additionalUsageQuota": "PT10H"
      }
    }
  ]
}

Определения

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

createdByType

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

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

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

InvitationState

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

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

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

PagedUsers

Object

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

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

ProvisioningState

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

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

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

RegistrationState

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

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

Значение	Описание
NotRegistered	Пользователь зарегистрировался в лаборатории.
Registered	Пользователь еще не зарегистрирован в лаборатории.

ResourceOperationError

Object

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

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

systemData

Object

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

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

User

Object

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

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

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

Users - List By Lab

Параметры URI

Ответы

Примеры

listUser

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

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

Определения

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User

Дополнительные ресурсы