Students - List

Service:

Education

API-versie:

2021-12-01-preview

Bekijk een lijst met details over leerlingen/studenten die zijn gekoppeld aan het opgegeven lab.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
billingAccountName	path	True	string	De id waarmee een factureringsrekening uniek wordt geïdentificeerd.
billingProfileName	path	True	string	De id waarmee een factureringsprofiel uniek wordt geïdentificeerd.
invoiceSectionName	path	True	string	De id waarmee een factuursectie uniek wordt geïdentificeerd.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. Huidige versie is 2021-12-01-preview
includeDeleted	query		boolean	Kan worden gebruikt om verwijderde items weer te geven.

Antwoorden

Name	Type	Description
200 OK	StudentListResult	Studentgegevens.
Other Status Codes	ErrorResponseBody	Beschrijft de fout als de bewerking niet lukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

StudentList

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Amount	Het bedrag.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorResponse	Beschrijft de indeling van foutreactie.
ErrorResponseBody	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.
Student Lab Status	Status van studentlab
Student role	Rol van leerling/student
StudentDetails	Studentgegevens.
StudentListResult	Lijst met leerlingen/studenten.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Amount

Object

Het bedrag.

Name	Type	Description
currency	string	Het type valuta dat wordt gebruikt voor de waarde.
value	number	Bedragwaarde.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Beschrijft de indeling van foutreactie.

Name	Type	Description
code	string	Foutcode
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponseBody

Object

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Name	Type	Description
error	ErrorResponse	De details van de fout.

Student Lab Status

Inventarisatie

Status van studentlab

Waarde	Description
Active
Disabled
Expired
Pending
Deleted

Student role

Inventarisatie

Rol van leerling/student

Waarde	Description
Student
Admin

StudentDetails

Object

Studentgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.budget	Amount	Studentenbudget
properties.effectiveDate	string (date-time)	Datum waarop student is toegevoegd aan het lab
properties.email	string	E-mailadres van leerling/student
properties.expirationDate	string (date-time)	De datum waarop deze leerling/student is ingesteld om te verlopen vanuit het lab.
properties.firstName	string	Voornaam
properties.lastName	string	Achternaam
properties.role	Student role	Rol van leerling/student
properties.status	Student Lab Status	Status van studentlab
properties.subscriptionAlias	string	Abonnementsalias
properties.subscriptionId	string	Abonnements-id
properties.subscriptionInviteLastSentDate	string (date-time)	abonnementstoenodiging laatst verzonden datum
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

StudentListResult

Object

Lijst met leerlingen/studenten.

Name	Type	Description
nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
value	StudentDetails[]	De lijst met leerlingen/studenten.

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.