Users - List By Lab

Service:

Lab Services

API Version:

2023-06-07

Alle gebruikers ophalen voor een lab.
Retourneert een lijst met alle gebruikers voor een lab.

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}

URI-parameters

Name	In	Vereist	Type	Description
labName	path	True	string	De naam van het lab dat het lab uniek identificeert in het labplan. Wordt gebruikt in resource-URI's.
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	Het filter dat moet worden toegepast op de bewerking.

Antwoorden

Name	Type	Description
200 OK	PagedUsers	De aanvraag is geslaagd; antwoord bevat alle gebruikers voor het opgegeven lab.
Other Status Codes	ErrorResponse	Het standaardfoutantwoord.

Voorbeelden

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
InvitationState	De status van de gebruikersuitnodiging van het lab.
PagedUsers	Lijst met pagina's met gebruikers.
ProvisioningState	Huidige inrichtingsstatus van de gebruikersresource.
RegistrationState	De registratiestatus van het gebruikerslab.
ResourceOperationError	Foutdetails van de meest recente bewerkingsfout in deze resource
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
User	Gebruiker van een lab dat zich kan registreren voor en gebruik kan maken van virtuele machines in het lab.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

InvitationState

De status van de gebruikersuitnodiging van het lab.

Name	Type	Description
Failed	string	Er is een fout opgetreden tijdens het verzenden van de uitnodiging.
NotSent	string	De uitnodiging is niet verzonden.
Sending	string	De uitnodiging wordt momenteel verzonden.
Sent	string	De uitnodiging is verzonden.

PagedUsers

Lijst met pagina's met gebruikers.

Name	Type	Description
nextLink	string	De koppeling om de volgende pagina met afbeeldingsresultaten op te halen.
value	User[]	De matrixpagina met gebruikersresultaten.

ProvisioningState

Huidige inrichtingsstatus van de gebruikersresource.

Name	Type	Description
Creating	string	De resource wordt gemaakt.
Deleting	string	De resource wordt verwijderd.
Failed	string	De vorige bewerking op de resource is mislukt, waardoor de resource niet in orde is.
Locked	string	De resource is vergrendeld en wijzigingen worden momenteel geblokkeerd. Dit kan worden veroorzaakt door onderhoud of een geplande bewerking. De status wordt teruggezet naar geslaagd zodra de vergrendelingsbewerking is voltooid.
Succeeded	string	Resource heeft een goede status na het maken of bijwerken.
Updating	string	Er worden nieuwe eigenschapswaarden toegepast op de resource.

RegistrationState

De registratiestatus van het gebruikerslab.

Name	Type	Description
NotRegistered	string	De gebruiker heeft zich geregistreerd bij het lab.
Registered	string	Gebruiker heeft zich nog niet geregistreerd bij het lab.

ResourceOperationError

Foutdetails van de meest recente bewerkingsfout in deze resource

Name	Type	Description
action	string	De bewerkingsactie die is mislukt
code	string	De code die overeenkomt met het type bewerkingsfout
message	string	Het foutbericht van de bewerking
timestamp	string	De datum/tijd waarop de fout is opgetreden

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

User

Gebruiker van een lab dat zich kan registreren voor en gebruik kan maken van virtuele machines in het lab.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.additionalUsageQuota	string	De hoeveelheid gebruiksquotumtijd die de gebruiker krijgt naast het quotum voor labgebruik.
properties.displayName	string	Weergavenaam van de gebruiker, bijvoorbeeld de volledige naam van de gebruiker.
properties.email	string	Het e-mailadres van de gebruiker.
properties.invitationSent	string	De datum en tijd waarop het uitnodigingsbericht naar de gebruiker is verzonden.
properties.invitationState	InvitationState	Status van het uitnodigingsbericht voor de gebruiker.
properties.provisioningState	ProvisioningState	Huidige inrichtingsstatus van de gebruikersresource.
properties.registrationState	RegistrationState	Status van de registratie van de gebruiker in het lab.
properties.resourceOperationError	ResourceOperationError	Foutdetails van de laatste bewerking die is uitgevoerd op het labplan.
properties.totalUsage	string	Hoe lang de gebruiker de virtuele machines in dit lab heeft gebruikt.
systemData	systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de gebruikersresource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'