Users - List By Lab

Referens

Tjänst:: Lab Services

API-version:: 2023-06-07

Hämta alla användare för ett labb.
Returnerar en lista över alla användare för ett labb.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
labName	path	True	string minLength: 1 maxLength: 100	Namnet på labbet som unikt identifierar det i en labbplan. Används i resurs-URI:er.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
$filter	query		string	Filtret som ska tillämpas på åtgärden.

Svar

Name	Typ	Description
200 OK	PagedUsers	Begäran lyckades. svaret innehåller alla användare för det angivna labbet.
Other Status Codes	ErrorResponse	Standardfelsvaret.

Exempel

listUser

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
InvitationState	Tillståndet för labbanvändarens inbjudan.
PagedUsers	Sidlista över användare.
ProvisioningState	Aktuellt etableringstillstånd för användarresursen.
RegistrationState	Registreringstillståndet för användarlabbet.
ResourceOperationError	Felinformation om det senaste åtgärdsfelet på den här resursen
systemData	Metadata som rör skapande och senaste ändring av resursen.
User	Användare av ett labb som kan registrera sig för och använda virtuella datorer i labbet.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

InvitationState

Uppräkning

Tillståndet för labbanvändarens inbjudan.

Värde	Description
Failed	Det uppstod ett fel när inbjudan skickades.
NotSent	Inbjudan har inte skickats.
Sending	Skickar för närvarande inbjudan.
Sent	Inbjudan har skickats.

PagedUsers

Objekt

Sidlista över användare.

Name	Typ	Description
nextLink	string	Länken för att hämta nästa sida med bildresultat.
value	User[]	Matrissidan för användarresultat.

ProvisioningState

Uppräkning

Aktuellt etableringstillstånd för användarresursen.

Värde	Description
Creating	Resursen håller på att skapas.
Deleting	Resursen håller på att tas bort.
Failed	Föregående åtgärd på resursen har misslyckats med att lämna resursen i feltillstånd.
Locked	Resursen är låst och ändringarna är för närvarande blockerade. Detta kan bero på underhåll eller en schemalagd åtgärd. Tillståndet återgår till lyckades när låsningsåtgärden har slutförts.
Succeeded	Resursen är i felfritt tillstånd när den har skapats eller uppdaterats.
Updating	Nya egenskapsvärden tillämpas på resursen.

RegistrationState

Uppräkning

Registreringstillståndet för användarlabbet.

Värde	Description
NotRegistered	Användaren har registrerat sig i labbet.
Registered	Användaren har ännu inte registrerat sig i labbet.

ResourceOperationError

Objekt

Felinformation om det senaste åtgärdsfelet på den här resursen

Name	Typ	Description
action	string	Åtgärdsåtgärden som misslyckades
code	string	Den kod som motsvarar typen av åtgärdsfel
message	string	Meddelandet om åtgärdsfel
timestamp	string (date-time)	Datetime för när felet inträffade

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

User

Objekt

Användare av ett labb som kan registrera sig för och använda virtuella datorer i labbet.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.additionalUsageQuota	string (duration)	Mängden användningskvottid som användaren får utöver labbanvändningskvoten.
properties.displayName	string	Användarens visningsnamn, till exempel användarens fullständiga namn.
properties.email	string minLength: 6 maxLength: 254	E-postadress till användaren.
properties.invitationSent	string (date-time)	Datum och tid då inbjudningsmeddelandet skickades till användaren.
properties.invitationState	InvitationState	Tillstånd för inbjudningsmeddelandet för användaren.
properties.provisioningState	ProvisioningState	Aktuellt etableringstillstånd för användarresursen.
properties.registrationState	RegistrationState	Tillstånd för användarens registrering i labbet.
properties.resourceOperationError	ResourceOperationError	Felinformation om den senaste åtgärden som utfördes i labbplanen.
properties.totalUsage	string (duration)	Hur länge användaren har använt sina virtuella datorer i det här labbet.
systemData	systemData	Metadata som rör skapande och senaste ändring av användarresursen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

Dela via

Users - List By Lab

URI-parametrar

Svar

Exempel

listUser

Exempelbegäran

Exempelsvar

Definitioner

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User

Ytterligare resurser