Users - List By Lab

Service:

Lab Services

API-versie:

2023-06-07

Alle gebruikers voor een lab ophalen.
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

Met optionele 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 minLength: 1 maxLength: 100	De naam van het lab dat het uniek identificeert in het labplan. Wordt gebruikt in resource-URI's.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	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; het antwoord bevat alle gebruikers voor het opgegeven lab.
Other Status Codes	ErrorResponse	Het standaardfoutantwoord.

Voorbeelden

listUser

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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 uitnodiging van de labgebruiker.
PagedUsers	Gepaginade lijst met gebruikers.
ProvisioningState	Huidige inrichtingsstatus van de gebruikersresource.
RegistrationState	De registratiestatus van het gebruikerslab.
ResourceOperationError	Foutdetails van de meest recente bewerkingsfout voor deze resource
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
User	Gebruiker van een lab dat zich kan registreren voor en virtuele machines in het lab kan gebruiken.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

Object

De foutdetails.

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

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

InvitationState

Inventarisatie

De status van de uitnodiging van de labgebruiker.

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

PagedUsers

Object

Gepaginade lijst 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

Inventarisatie

Huidige inrichtingsstatus van de gebruikersresource.

Waarde	Description
Creating	De resource wordt gemaakt.
Deleting	De resource wordt verwijderd.
Failed	De vorige bewerking voor de resource is mislukt, waardoor de resource niet in orde is.
Locked	De resource is vergrendeld en wijzigingen worden momenteel geblokkeerd. Dit kan worden veroorzaakt door onderhoud of een geplande bewerking. De status wordt weer voltooid zodra de vergrendelingsbewerking is voltooid.
Succeeded	De resource heeft de status In orde na het maken of bijwerken.
Updating	Nieuwe eigenschapswaarden worden toegepast op de resource.

RegistrationState

Inventarisatie

De registratiestatus van het gebruikerslab.

Waarde	Description
NotRegistered	Gebruiker heeft zich geregistreerd bij het lab.
Registered	De gebruiker is nog niet geregistreerd bij het lab.

ResourceOperationError

Object

Foutdetails van de meest recente bewerkingsfout voor 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 over de bewerking
timestamp	string (date-time)	De datum/tijd waarop de fout is opgetreden

systemData

Object

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

Name	Type	Description
createdAt	string (date-time)	De 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 (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

User

Object

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

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 (duration)	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 minLength: 6 maxLength: 254	E-mailadres van de gebruiker.
properties.invitationSent	string (date-time)	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 in het labplan.
properties.totalUsage	string (duration)	Hoe lang de gebruiker de virtuele machines in dit lab heeft gebruikt.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de gebruikersresource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'