Users - List By Lab

Odwołanie

Service:: Lab Services

API Version:: 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

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
labName	path	True	string	Nazwa laboratorium, które jednoznacznie identyfikuje je w ramach planu laboratorium. Używane w identyfikatorach URI zasobów.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	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ź na błąd.

Przykłady

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"
      }
    }
  ]
}

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	Strona listy użytkowników.
ProvisioningState	Bieżący stan aprowizacji zasobu użytkownika.
RegistrationState	Stan rejestracji laboratorium użytkownika.
ResourceOperationError	Szczegóły błędu najnowszej operacji w tym zasobie
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
User	Użytkownik laboratorium, które może zarejestrować się i korzystać z maszyn wirtualnych w laboratorium.

createdByType

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

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

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

ErrorDetail

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

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

InvitationState

Stan zaproszenia użytkownika laboratorium.

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

PagedUsers

Strona listy użytkowników.

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

ProvisioningState

Bieżący stan aprowizacji zasobu użytkownika.

Nazwa	Typ	Opis
Creating	string	Zasób jest w trakcie tworzenia.
Deleting	string	Zasób jest w trakcie usuwania.
Failed	string	Poprzednia operacja zasobu nie powiodła się, pozostawiając zasób w złej kondycji.
Locked	string	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	string	Zasób jest w dobrej kondycji po utworzeniu lub operacji aktualizacji.
Updating	string	Nowe wartości właściwości są stosowane do zasobu.

RegistrationState

Stan rejestracji laboratorium użytkownika.

Nazwa	Typ	Opis
NotRegistered	string	Użytkownik zarejestrował się w laboratorium.
Registered	string	Użytkownik nie zarejestrował się jeszcze w laboratorium.

ResourceOperationError

Szczegóły błędu najnowszej operacji w tym zasobie

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

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	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	Sygnatura czasowa 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

Użytkownik laboratorium, które może zarejestrować się i korzystać z maszyn wirtualnych 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	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	Adres e-mail użytkownika.
properties.invitationSent	string	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	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"