Students - List

Servizio:

Education

Versione API:

2021-12-01-preview

Ottenere un elenco di dettagli sugli studenti associati al lab specificato.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?api-version=2021-12-01-preview

Con parametri facoltativi:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?includeDeleted={includeDeleted}&api-version=2021-12-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
billingAccountName	path	True	string	ID che identifica in modo univoco un account di fatturazione.
billingProfileName	path	True	string	ID che identifica in modo univoco un profilo di fatturazione.
invoiceSectionName	path	True	string	ID che identifica in modo univoco una sezione della fattura.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2021-12-01-preview
includeDeleted	query		boolean	Può essere utilizzato per visualizzare gli elementi eliminati.

Risposte

Nome	Tipo	Descrizione
200 OK	StudentListResult	Dettagli degli studenti.
Other Status Codes	ErrorResponseBody	Descrive l'errore se l'operazione non riesce.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

StudentList

Esempio di richiesta

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?api-version=2021-12-01-preview

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}",
      "name": "{studentAlias}",
      "type": "Microsoft.Education/Students",
      "properties": {
        "firstName": "test",
        "lastName": "user",
        "email": "test@contoso.com",
        "role": "Student",
        "budget": {
          "currency": "USD",
          "value": 100
        },
        "subscriptionId": "000000000-0000-0000-0000-00000000000000",
        "expirationDate": "2022-11-09T21:43:54.161Z",
        "status": "Active",
        "effectiveDate": "2021-11-09T21:43:54.161Z",
        "subscriptionAlias": "000000000-0000-0000-0000-00000000000000",
        "subscriptionInviteLastSentDate": "2021-11-09T21:43:54.161Z"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Amount	Quantità.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorResponse	Descrive il formato della risposta di errore.
ErrorResponseBody	La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
Student Lab Status	Stato del laboratorio degli studenti
Student role	Ruolo studente
StudentDetails	Dettagli degli studenti.
StudentListResult	Elenco di studenti.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

Amount

Object

Quantità.

Nome	Tipo	Descrizione
currency	string	Tipo di valuta utilizzato per il valore.
value	number	Valore dell'importo.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Descrive il formato della risposta di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponseBody

Object

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorResponse	Dettagli dell'errore.

Student Lab Status

Enumerazione

Stato del laboratorio degli studenti

Valore	Descrizione
Active
Disabled
Expired
Pending
Deleted

Student role

Enumerazione

Ruolo studente

Valore	Descrizione
Student
Admin

StudentDetails

Object

Dettagli degli studenti.

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.budget	Amount	Budget studenti
properties.effectiveDate	string (date-time)	Data di aggiunta dello studente al lab
properties.email	string	Indirizzo di posta elettronica degli studenti
properties.expirationDate	string (date-time)	Data in cui questo studente è impostato per scadere dal lab.
properties.firstName	string	Nome di battesimo
properties.lastName	string	Cognome
properties.role	Student role	Ruolo studente
properties.status	Student Lab Status	Stato del laboratorio degli studenti
properties.subscriptionAlias	string	Alias della sottoscrizione
properties.subscriptionId	string	ID sottoscrizione
properties.subscriptionInviteLastSentDate	string (date-time)	data dell'ultimo invio dell'invito alla sottoscrizione
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

StudentListResult

Object

Elenco di studenti.

Nome	Tipo	Descrizione
nextLink	string	Collegamento (URL) alla pagina successiva dei risultati.
value	StudentDetails[]	Elenco di studenti.

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.