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	要求が成功しました。response には、特定のラボのすべてのユーザーが含まれます。
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	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
InvitationState	ラボユーザー招待の状態。
PagedUsers	ユーザーのページ一覧。
ProvisioningState	ユーザーリソースの現在のプロビジョニング状態。
RegistrationState	ユーザーラボの登録状態。
ResourceOperationError	このリソースに対する最新の操作エラーのエラーの詳細
systemData	リソースの作成と最後の変更に関連するメタデータ。
User	ラボ内の仮想マシンに登録して使用できるラボのユーザー。

createdByType

リソースを作成した ID の種類。

名前	型	説明
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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

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"