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	Nome del lab che lo identifica in modo univoco all'interno del piano lab contenitore. Usato negli URI delle risorse.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	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

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

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

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

InvitationState

Stato di invito dell'utente del lab.

Nome	Tipo	Descrizione
Failed	string	Errore durante l'invio dell'invito.
NotSent	string	L'invito non è stato inviato.
Sending	string	Invio dell'invito.
Sent	string	L'invito è stato inviato correttamente.

PagedUsers

Elenco di utenti con paging.

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

ProvisioningState

Stato di provisioning corrente della risorsa utente.

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

RegistrationState

Stato di registrazione del lab utente.

Nome	Tipo	Descrizione
NotRegistered	string	L'utente ha eseguito la registrazione al lab.
Registered	string	L'utente non ha ancora eseguito la registrazione nel lab.

ResourceOperationError

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	Datetime di quando si è verificato l'errore

systemData

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

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	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

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

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.additionalUsageQuota	string	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 nome completo dell'utente.
properties.email	string	Indirizzo di posta elettronica dell'utente.
properties.invitationSent	string	Data e ora di 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 nel piano del lab.
properties.totalUsage	string	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 di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Condividi tramite