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 매개 변수

Name	In(다음 안에)	필수	형식	Description
labName	path	True	string minLength: 1 maxLength: 100	랩 계획을 포함하는 내에서 고유하게 식별하는 랩의 이름입니다. 리소스 URI에 사용됩니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
$filter	query		string	작업에 적용할 필터입니다.

응답

Name	형식	Description
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"
      }
    }
  ]
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
InvitationState	랩 사용자 초대 상태입니다.
PagedUsers	페이징된 사용자 목록입니다.
ProvisioningState	사용자 리소스의 현재 프로비전 상태입니다.
RegistrationState	사용자 랩 등록 상태입니다.
ResourceOperationError	이 리소스에 대한 최신 작업 실패에 대한 오류 세부 정보
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
User	랩 내에서 가상 머신을 등록하고 사용할 수 있는 랩의 사용자입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

InvitationState

열거형

랩 사용자 초대 상태입니다.

값	Description
Failed	초대를 보내는 동안 오류가 발생했습니다.
NotSent	초대가 전송되지 않았습니다.
Sending	현재 초대를 보냅니다.
Sent	초대가 성공적으로 전송되었습니다.

PagedUsers

Object

페이징된 사용자 목록입니다.

Name	형식	Description
nextLink	string	이미지 결과의 다음 페이지를 가져올 링크입니다.
value	User[]	사용자 결과의 배열 페이지입니다.

ProvisioningState

열거형

사용자 리소스의 현재 프로비전 상태입니다.

값	Description
Creating	리소스를 만드는 중입니다.
Deleting	리소스가 삭제되는 중입니다.
Failed	리소스에 대한 이전 작업이 비정상 상태로 리소스를 남기지 못했습니다.
Locked	리소스가 잠겨 있고 변경 내용이 현재 차단됩니다. 이는 유지 관리 또는 예약된 작업 때문일 수 있습니다. 잠금 작업이 완료되면 상태가 다시 성공으로 돌아갑니다.
Succeeded	리소스는 생성 또는 업데이트 작업 후 정상 상태입니다.
Updating	리소스에 새 속성 값이 적용되고 있습니다.

RegistrationState

열거형

사용자 랩 등록 상태입니다.

값	Description
NotRegistered	사용자가 랩에 등록했습니다.
Registered	사용자가 아직 랩에 등록하지 않았습니다.

ResourceOperationError

Object

이 리소스에 대한 최신 작업 실패에 대한 오류 세부 정보

Name	형식	Description
action	string	실패한 작업 작업
code	string	작업 오류 유형에 해당하는 코드입니다.
message	string	작업 실패 메시지
timestamp	string (date-time)	오류가 발생한 날짜/시간입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

User

Object

랩 내에서 가상 머신을 등록하고 사용할 수 있는 랩의 사용자입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.additionalUsageQuota	string (duration)	랩 사용 할당량 외에도 사용자가 가져오는 사용 할당량 시간입니다.
properties.displayName	string	사용자의 표시 이름(예: 사용자의 전체 이름)입니다.
properties.email	string minLength: 6 maxLength: 254	사용자의 Email 주소입니다.
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

추가 리소스