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 參數

名稱	位於	必要	類型	Description
labName	path	True	string	在包含實驗室計劃內唯一識別該實驗室的實驗室名稱。用於資源 URI。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。
$filter	query		string	要套用至作業的篩選條件。

回應

名稱	類型	Description
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"
      }
    }
  ]
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
InvitationState	實驗室使用者邀請狀態。
PagedUsers	已分頁的用戶清單。
ProvisioningState	用戶資源的目前布建狀態。
RegistrationState	用戶實驗室註冊狀態。
ResourceOperationError	此資源上最新作業失敗的錯誤詳細數據
systemData	與建立和上次修改資源相關的元數據。
User	實驗室的使用者，可註冊及使用實驗室內的虛擬機。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

InvitationState

實驗室使用者邀請狀態。

名稱	類型	Description
Failed	string	傳送邀請時發生錯誤。
NotSent	string	尚未傳送邀請。
Sending	string	目前傳送邀請。
Sent	string	已成功傳送邀請。

PagedUsers

已分頁的用戶清單。

名稱	類型	Description
nextLink	string	取得影像結果下一頁的連結。
value	User[]	用戶結果的陣列頁面。

ProvisioningState

用戶資源的目前布建狀態。

名稱	類型	Description
Creating	string	資源正在建立中。
Deleting	string	正在刪除資源。
Failed	string	資源的上一個作業失敗，導致資源處於狀況不良狀態。
Locked	string	資源已鎖定，且目前已封鎖變更。這可能是因為維護或排程的作業所造成。鎖定作業完成後，狀態會回復為成功。
Succeeded	string	資源在建立或更新作業之後處於狀況良好的狀態。
Updating	string	新的屬性值會套用至資源。

RegistrationState

用戶實驗室註冊狀態。

名稱	類型	Description
NotRegistered	string	使用者已向實驗室註冊。
Registered	string	使用者尚未向實驗室註冊。

ResourceOperationError

此資源上最新作業失敗的錯誤詳細數據

名稱	類型	Description
action	string	失敗的作業動作
code	string	對應至作業失敗類型的程序代碼
message	string	作業失敗訊息
timestamp	string	發生錯誤的日期時間

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

User

實驗室的使用者，可註冊及使用實驗室內的虛擬機。

名稱	類型	Description
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”

Share via

Users - List By Lab

URI 參數

回應

範例

listUser

Sample Request

Sample Response

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User

其他資源