Users - List By Lab

Referenz

Dienst:: Lab Services

API-Version:: 2023-06-07

Rufen Sie alle Benutzer für ein Lab ab.
Gibt eine Liste aller Benutzer für ein Lab 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	Der Name des Labs, das es innerhalb des lab-Plans eindeutig identifiziert. Wird in Ressourcen-URIs verwendet.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PagedUsers	Die Anforderung war erfolgreich; response enthält alle Benutzer für das angegebene Lab.
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	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
InvitationState	Der Einladungsstatus des Labbenutzers.
PagedUsers	Ausgelagerte Liste der Benutzer.
ProvisioningState	Aktueller Bereitstellungsstatus der Benutzerressource.
RegistrationState	Der Registrierungsstatus des Benutzerlabors.
ResourceOperationError	Fehlerdetails des letzten Vorgangsfehlers für diese Ressource
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
User	Benutzer eines Labs, das virtuelle Computer innerhalb des Labs registrieren und verwenden kann.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

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

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InvitationState

Der Einladungsstatus des Labbenutzers.

Name	Typ	Beschreibung
Failed	string	Fehler beim Senden der Einladung.
NotSent	string	Die Einladung wurde nicht gesendet.
Sending	string	Derzeit wird die Einladung gesendet.
Sent	string	Die Einladung wurde erfolgreich gesendet.

PagedUsers

Ausgelagerte Liste der Benutzer.

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

ProvisioningState

Aktueller Bereitstellungsstatus der Benutzerressource.

Name	Typ	Beschreibung
Creating	string	Die Ressource wird gerade erstellt.
Deleting	string	Die Ressource wird gerade gelöscht.
Failed	string	Beim vorherigen Vorgang für die Ressource ist ein Fehler aufgetreten, und die Ressource wurde in einem fehlerhaften Zustand belassen.
Locked	string	Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf eine Wartung oder einen geplanten Betrieb zurückzuführen sein. Nach Abschluss des Sperrvorgangs wechselt der Status zurück zu "erfolgreich".
Succeeded	string	Die Ressource befindet sich nach dem Erstellungs- oder Aktualisierungsvorgang in einem fehlerfreien Zustand.
Updating	string	Neue Eigenschaftswerte werden auf die Ressource angewendet.

RegistrationState

Der Registrierungsstatus des Benutzerlabors.

Name	Typ	Beschreibung
NotRegistered	string	Der Benutzer hat sich beim Lab registriert.
Registered	string	Der Benutzer hat sich noch nicht beim Lab registriert.

ResourceOperationError

Fehlerdetails des letzten 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	Meldung zum Vorgangsfehler
timestamp	string	Datetime des Fehlers

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	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	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

Benutzer eines Labs, das virtuelle Computer innerhalb des Labs registrieren und verwenden kann.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.additionalUsageQuota	string	Die Zeit des Nutzungskontingents, die der Benutzer zusätzlich zum Labnutzungskontingent erhält.
properties.displayName	string	Anzeigename des Benutzers, z. B. vollständiger Name des Benutzers.
properties.email	string	E-Mail-Adresse des Benutzers
properties.invitationSent	string	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 im Lab.
properties.resourceOperationError	ResourceOperationError	Fehlerdetails des letzten Vorgangs, der im Labplan ausgeführt wurde.
properties.totalUsage	string	Wie lange der Benutzer seine virtuellen Computer in diesem Lab verwendet hat.
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Benutzerressource beziehen.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Freigeben über