Users - List By Lab

Odwołanie

Usługa:: Lab Services

Wersja interfejsu API:: 2023-06-07

Pobierz wszystkich użytkowników laboratorium.
Zwraca listę wszystkich użytkowników laboratorium.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07

Z parametrami opcjonalnymi:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07&$filter={$filter}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
labName	path	True	string minLength: 1 maxLength: 100	Nazwa laboratorium, które jednoznacznie identyfikuje je w ramach planu laboratorium. Używane w identyfikatorach URI zasobów.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Filtr do zastosowania do operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PagedUsers	Żądanie zakończyło się pomyślnie; odpowiedź zawiera wszystkich użytkowników dla danego laboratorium.
Other Status Codes	ErrorResponse	Domyślna odpowiedź o błędzie.

Przykłady

listUser

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
InvitationState	Stan zaproszenia użytkownika laboratorium.
PagedUsers	Lista stronicowanych użytkowników.
ProvisioningState	Bieżący stan aprowizacji zasobu użytkownika.
RegistrationState	Stan rejestracji laboratorium użytkownika.
ResourceOperationError	Szczegóły błędu dotyczące najnowszego błędu operacji w tym zasobie
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
User	Użytkownik laboratorium, które może zarejestrować się na maszynach wirtualnych i korzystać z nich w laboratorium.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

InvitationState

Wyliczanie

Stan zaproszenia użytkownika laboratorium.

Wartość	Opis
Failed	Wystąpił błąd podczas wysyłania zaproszenia.
NotSent	Zaproszenie nie zostało wysłane.
Sending	Obecnie wysyła zaproszenie.
Sent	Zaproszenie zostało pomyślnie wysłane.

PagedUsers

Objekt

Lista stronicowanych użytkowników.

Nazwa	Typ	Opis
nextLink	string	Link umożliwiający pobranie następnej strony wyników obrazu.
value	User[]	Strona tablicy wyników użytkownika.

ProvisioningState

Wyliczanie

Bieżący stan aprowizacji zasobu użytkownika.

Wartość	Opis
Creating	Zasób jest w trakcie tworzenia.
Deleting	Zasób jest w trakcie usuwania.
Failed	Poprzednia operacja zasobu nie powiodła się, pozostawiając zasób w złej kondycji.
Locked	Zasób jest zablokowany i zmiany są obecnie blokowane. Może to być spowodowane konserwacją lub zaplanowaną operacją. Stan powróci do powodzenia po zakończeniu operacji blokowania.
Succeeded	Zasób jest w dobrej kondycji po utworzeniu lub operacji aktualizacji.
Updating	Nowe wartości właściwości są stosowane do zasobu.

RegistrationState

Wyliczanie

Stan rejestracji laboratorium użytkownika.

Wartość	Opis
NotRegistered	Użytkownik zarejestrował się w laboratorium.
Registered	Użytkownik jeszcze nie zarejestrował się w laboratorium.

ResourceOperationError

Objekt

Szczegóły błędu dotyczące najnowszego błędu operacji w tym zasobie

Nazwa	Typ	Opis
action	string	Akcja operacji, która nie powiodła się
code	string	Kod odpowiadający typowi błędu operacji
message	string	Komunikat o niepowodzeniu operacji
timestamp	string (date-time)	Data/godzina wystąpienia błędu

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

User

Objekt

Użytkownik laboratorium, które może zarejestrować się na maszynach wirtualnych i korzystać z nich w laboratorium.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.additionalUsageQuota	string (duration)	Ilość czasu przydziału użycia, który użytkownik otrzymuje oprócz limitu przydziału użycia laboratorium.
properties.displayName	string	Nazwa wyświetlana użytkownika, na przykład pełna nazwa użytkownika.
properties.email	string minLength: 6 maxLength: 254	Adres e-mail użytkownika.
properties.invitationSent	string (date-time)	Data i godzina wysłania wiadomości z zaproszeniem do użytkownika.
properties.invitationState	InvitationState	Stan wiadomości z zaproszeniem dla użytkownika.
properties.provisioningState	ProvisioningState	Bieżący stan aprowizacji zasobu użytkownika.
properties.registrationState	RegistrationState	Stan rejestracji użytkownika w laboratorium.
properties.resourceOperationError	ResourceOperationError	Szczegóły błędu ostatniej operacji wykonanej w planie laboratorium.
properties.totalUsage	string (duration)	Jak długo użytkownik użył swoich maszyn wirtualnych w tym laboratorium.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu użytkownika.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

Udostępnij za pośrednictwem

Users - List By Lab

Parametry identyfikatora URI

Odpowiedzi

Przykłady

listUser

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User

Dodatkowe zasoby