Users - List By Lab

Riferimento

Servizio:: Lab Services

Versione API:: 2023-06-07

Ottenere tutti gli utenti per un lab.
Restituisce un elenco di tutti gli utenti per un lab.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
labName	path	True	string minLength: 1 maxLength: 100	Nome del lab che lo identifica in modo univoco all'interno del piano lab contenitore. Usato negli URI delle risorse.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$filter	query		string	Filtro da applicare all'operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PagedUsers	La richiesta ha avuto esito positivo; la risposta contiene tutti gli utenti per il lab specificato.
Other Status Codes	ErrorResponse	Risposta di errore predefinita.

Esempio

listUser

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
InvitationState	Stato di invito dell'utente del lab.
PagedUsers	Elenco di utenti con paging.
ProvisioningState	Stato di provisioning corrente della risorsa utente.
RegistrationState	Stato di registrazione del lab utente.
ResourceOperationError	Dettagli dell'errore dell'operazione più recente in questa risorsa
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
User	Utente di un lab che può registrarsi e usare macchine virtuali all'interno del lab.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

InvitationState

Enumerazione

Stato di invito dell'utente del lab.

Valore	Descrizione
Failed	Errore durante l'invio dell'invito.
NotSent	L'invito non è stato inviato.
Sending	Attualmente l'invio dell'invito.
Sent	L'invito è stato inviato correttamente.

PagedUsers

Object

Elenco di utenti con paging.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per ottenere la pagina successiva dei risultati dell'immagine.
value	User[]	Pagina di matrice dei risultati dell'utente.

ProvisioningState

Enumerazione

Stato di provisioning corrente della risorsa utente.

Valore	Descrizione
Creating	La risorsa è in corso di creazione.
Deleting	La risorsa è in corso di eliminazione.
Failed	L'operazione precedente sulla risorsa non è riuscita a lasciare la risorsa in stato non integro.
Locked	La risorsa è bloccata e le modifiche sono attualmente bloccate. Ciò potrebbe essere dovuto alla manutenzione o a un'operazione pianificata. Lo stato tornerà al completamento dell'operazione di blocco.
Succeeded	La risorsa è in stato integro dopo la creazione o l'operazione di aggiornamento.
Updating	Alla risorsa vengono applicati nuovi valori di proprietà.

RegistrationState

Enumerazione

Stato di registrazione del lab utente.

Valore	Descrizione
NotRegistered	L'utente ha eseguito la registrazione al lab.
Registered	L'utente non è ancora registrato nel lab.

ResourceOperationError

Object

Dettagli dell'errore dell'operazione più recente in questa risorsa

Nome	Tipo	Descrizione
action	string	Azione dell'operazione non riuscita
code	string	Codice che corrisponde al tipo di errore dell'operazione
message	string	Messaggio di errore dell'operazione
timestamp	string (date-time)	Datetime di quando si è verificato l'errore

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

User

Object

Utente di un lab che può registrarsi e usare macchine virtuali all'interno del lab.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.additionalUsageQuota	string (duration)	Quantità di tempo di quota di utilizzo che l'utente ottiene oltre alla quota di utilizzo del lab.
properties.displayName	string	Nome visualizzato dell'utente, ad esempio il nome completo dell'utente.
properties.email	string minLength: 6 maxLength: 254	Email indirizzo dell'utente.
properties.invitationSent	string (date-time)	Data e ora dell'invio del messaggio di invito all'utente.
properties.invitationState	InvitationState	Stato del messaggio di invito per l'utente.
properties.provisioningState	ProvisioningState	Stato di provisioning corrente della risorsa utente.
properties.registrationState	RegistrationState	Stato della registrazione dell'utente all'interno del lab.
properties.resourceOperationError	ResourceOperationError	Dettagli dell'errore dell'ultima operazione eseguita sul piano lab.
properties.totalUsage	string (duration)	Per quanto tempo l'utente ha usato le macchine virtuali in questo lab.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa utente.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Condividi tramite

Users - List By Lab

Parametri dell'URI

Risposte

Esempio

listUser

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User

Risorse aggiuntive