你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Users - List By Lab

Service:

Lab Services

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

With optional parameters:

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	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。
$filter	query		string	要应用于操作的筛选器。

响应

名称	类型	说明
200 OK	PagedUsers	请求成功;响应包含给定实验室的所有用户。
Other Status Codes	ErrorResponse	默认错误响应。

示例

listUser

Sample Request

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

Sample Response

Status code:

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	错误对象。

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	资源的完全限定的资源 ID。 例如 - /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”