Students - List

Dienst:

Education

API-Version:

2021-12-01-preview

Rufen Sie eine Liste der Details zu Kursteilnehmern ab, die dem angegebenen Labor zugeordnet sind.

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

Mit optionalen Parametern:

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountName	path	True	string	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
billingProfileName	path	True	string	Die ID, die ein Abrechnungsprofil eindeutig identifiziert.
invoiceSectionName	path	True	string	Die ID, die einen Rechnungsabschnitt eindeutig identifiziert.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Aktuelle Version ist 2021-12-01-Preview
includeDeleted	query		boolean	Kann verwendet werden, um gelöschte Elemente anzuzeigen.

Antworten

Name	Typ	Beschreibung
200 OK	StudentListResult	Details des Kursteilnehmers.
Other Status Codes	ErrorResponseBody	Beschreibt den Fehler, wenn der Vorgang nicht erfolgreich ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

StudentList

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Amount	Der Betrag.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorResponse	Beschreibt das Format der Fehlerantwort.
ErrorResponseBody	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
Student Lab Status	Status des Schülerlabors
Student role	Schülerrolle
StudentDetails	Details des Kursteilnehmers.
StudentListResult	Liste der Kursteilnehmer.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

Amount

Objekt

Der Betrag.

Name	Typ	Beschreibung
currency	string	Der Typ der Währung, die für den Wert verwendet wird.
value	number	Betragswert.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponseBody

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorResponse	Die Details des Fehlers.

Student Lab Status

Enumeration

Status des Schülerlabors

Wert	Beschreibung
Active
Disabled
Expired
Pending
Deleted

Student role

Enumeration

Schülerrolle

Wert	Beschreibung
Student
Admin

StudentDetails

Objekt

Details des Kursteilnehmers.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.budget	Amount	Kursteilnehmerbudget
properties.effectiveDate	string (date-time)	Datum, an dem Kursteilnehmer zum Labor hinzugefügt wurde
properties.email	string	Schüler-E-Mail
properties.expirationDate	string (date-time)	Das Datum, an dem dieser Kursteilnehmer festgelegt ist, läuft ab dem Labor ab.
properties.firstName	string	First Name (Vorname)
properties.lastName	string	Last Name (Nachname)
properties.role	Student role	Schülerrolle
properties.status	Student Lab Status	Status des Schülerlabors
properties.subscriptionAlias	string	Abonnementalias
properties.subscriptionId	string	Subscription Id (Abonnement-ID)
properties.subscriptionInviteLastSentDate	string (date-time)	Datum der letzten Übermittlung der Abonnement-Einladung
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

StudentListResult

Objekt

Liste der Kursteilnehmer.

Name	Typ	Beschreibung
nextLink	string	Der Link (URL) zur nächsten Seite der Ergebnisse.
value	StudentDetails[]	Die Liste der Kursteilnehmer.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.