Users - List By Lab

Dienst:: Lab Services

API-Version:: 2023-06-07

Rufen Sie alle Benutzer für eine Übung ab.
Gibt eine Liste aller Benutzer für eine Übung zurück.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string minLength: 1 maxLength: 100	Der Name des Labors, das es innerhalb eines Laborplans eindeutig identifiziert. Wird in Ressourcen-URIs verwendet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PagedUsers	Die Anforderung war erfolgreich; die Antwort enthält alle Benutzer für die angegebene Übung.
Other Status Codes	ErrorResponse	Die Standardfehlerantwort.

Beispiele

listUser

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InvitationState	Der Einladungsstatus der Übungsbenutzer.
PagedUsers	Seitenliste der Benutzer.
ProvisioningState	Aktueller Bereitstellungsstatus der Benutzerressource.
RegistrationState	Der Registrierungsstatus des Benutzerlabors.
ResourceOperationError	Fehlerdetails des neuesten Vorgangsfehlers für diese Ressource
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
User	Benutzer eines Labors, das sich für virtuelle Computer im Labor registrieren und verwenden kann.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InvitationState

Enumeration

Der Einladungsstatus der Übungsbenutzer.

Wert	Beschreibung
NotSent	Die Einladung wurde nicht gesendet.
Sending	Die Einladung wird zurzeit gesendet.
Sent	Die Einladung wurde erfolgreich gesendet.
Failed	Fehler beim Senden der Einladung.

PagedUsers

Objekt

Seitenliste der Benutzer.

Name	Typ	Beschreibung
nextLink	string	Der Link zum Abrufen der nächsten Seite mit Bildergebnissen.
value	User[]	Die Arrayseite der Benutzerergebnisse.

ProvisioningState

Enumeration

Aktueller Bereitstellungsstatus der Benutzerressource.

Wert	Beschreibung
Creating	Die Ressource wird gerade erstellt.
Updating	Neue Eigenschaftswerte werden auf die Ressource angewendet.
Deleting	Die Ressource wird gelöscht.
Succeeded	Die Ressource befindet sich nach dem Erstellungs- oder Aktualisierungsvorgang im fehlerfreien Zustand.
Failed	Der vorherige Vorgang für die Ressource ist fehlgeschlagen, wenn die Ressource im fehlerhaften Zustand verlassen wurde.
Locked	Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf Wartung oder einen geplanten Betrieb zurückzuführen sein. Der Zustand wechselt zurück, um erfolgreich zu sein, nachdem der Sperrvorgang abgeschlossen ist.

RegistrationState

Enumeration

Der Registrierungsstatus des Benutzerlabors.

Wert	Beschreibung
NotRegistered	Der Benutzer hat sich bei der Übung registriert.
Registered	Der Benutzer hat sich noch nicht bei der Übung registriert.

ResourceOperationError

Objekt

Fehlerdetails des neuesten Vorgangsfehlers für diese Ressource

Name	Typ	Beschreibung
action	string	Die fehlgeschlagene Vorgangsaktion
code	string	Der Code, der dem Typ des Vorgangsfehlers entspricht
message	string	Fehlermeldung des Vorgangs
timestamp	string (date-time)	Datum und Uhrzeit des Auftretens des Fehlers

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

User

Objekt

Benutzer eines Labors, das sich für virtuelle Computer im Labor registrieren und verwenden kann.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.additionalUsageQuota	string (duration)	Die Menge der Nutzungskontingente, die der Benutzer zusätzlich zum Lab-Nutzungskontingent erhält.
properties.displayName	string	Anzeigename des Benutzers, z. B. vollständiger Name des Benutzers.
properties.email	string minLength: 6 maxLength: 254	Email Adresse des Benutzers.
properties.invitationSent	string (date-time)	Datum und Uhrzeit, zu dem die Einladungsnachricht an den Benutzer gesendet wurde.
properties.invitationState	InvitationState	Status der Einladungsnachricht für den Benutzer.
properties.provisioningState	ProvisioningState	Aktueller Bereitstellungsstatus der Benutzerressource.
properties.registrationState	RegistrationState	Status der Registrierung des Benutzers innerhalb des Labors.
properties.resourceOperationError	ResourceOperationError	Fehlerdetails des letzten Vorgangs, der im Laborplan ausgeführt wurde.
properties.totalUsage	string (duration)	Wie lange der Benutzer seine virtuellen Computer in dieser Übung verwendet hat.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Benutzerressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Freigeben über

Users - List By Lab

URI-Parameter

Antworten

Beispiele

listUser

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User