Students - List

Usługa:

Education

Wersja interfejsu API:

2021-12-01-preview

Pobierz listę szczegółów dotyczących uczniów skojarzonych z określonym laboratorium.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingAccountName	path	True	string	Identyfikator, który jednoznacznie identyfikuje konto rozliczeniowe.
billingProfileName	path	True	string	Identyfikator, który jednoznacznie identyfikuje profil rozliczeniowy.
invoiceSectionName	path	True	string	Identyfikator, który jednoznacznie identyfikuje sekcję faktury.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2021-12-01-preview
includeDeleted	query		boolean	Może służyć do wyświetlania usuniętych elementów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	StudentListResult	Szczegóły ucznia.
Other Status Codes	ErrorResponseBody	Opisuje błąd, jeśli operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

StudentList

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
Amount	Kwota.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorResponse	Opisuje format odpowiedzi Błąd.
ErrorResponseBody	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.
Student Lab Status	Stan laboratorium ucznia
Student role	Rola ucznia
StudentDetails	Szczegóły ucznia.
StudentListResult	Lista uczniów.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Amount

Objekt

Kwota.

Nazwa	Typ	Opis
currency	string	Typ waluty używanej dla wartości.
value	number	Wartość kwoty.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Opisuje format odpowiedzi Błąd.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponseBody

Objekt

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorResponse	Szczegóły błędu.

Student Lab Status

Wyliczanie

Stan laboratorium ucznia

Wartość	Opis
Active
Disabled
Expired
Pending
Deleted

Student role

Wyliczanie

Rola ucznia

Wartość	Opis
Student
Admin

StudentDetails

Objekt

Szczegóły ucznia.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.budget	Amount	Budżet ucznia
properties.effectiveDate	string (date-time)	Data dodania ucznia do laboratorium
properties.email	string	Adres e-mail ucznia
properties.expirationDate	string (date-time)	Data wygaśnięcia tego ucznia z laboratorium.
properties.firstName	string	Imię
properties.lastName	string	Nazwisko
properties.role	Student role	Rola ucznia
properties.status	Student Lab Status	Stan laboratorium ucznia
properties.subscriptionAlias	string	Alias subskrypcji
properties.subscriptionId	string	Identyfikator subskrypcji
properties.subscriptionInviteLastSentDate	string (date-time)	data ostatniego wysłania zaproszenia subskrypcji
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

StudentListResult

Objekt

Lista uczniów.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	StudentDetails[]	Lista uczniów.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.