Students - List

Služba:

Education

Verze rozhraní API:

2021-12-01-preview

Získejte seznam podrobností o studentech přidružených k zadanému testovacímu prostředí.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
billingAccountName	path	True	string	ID, které jednoznačně identifikuje fakturační účet.
billingProfileName	path	True	string	ID, které jednoznačně identifikuje fakturační profil.
invoiceSectionName	path	True	string	ID, které jednoznačně identifikuje oddíl faktury.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2021-12-01-preview
includeDeleted	query		boolean	Lze použít k zobrazení odstraněných položek.

Odpovědi

Name	Typ	Description
200 OK	StudentListResult	Podrobnosti o studentech.
Other Status Codes	ErrorResponseBody	Popisuje chybu, pokud operace není úspěšná.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

StudentList

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Amount	Částka.
createdByType	Typ identity, která prostředek vytvořila.
ErrorResponse	Popisuje formát odpovědi na chybu.
ErrorResponseBody	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.
Student Lab Status	Stav studentského testovacího prostředí
Student role	Role studenta
StudentDetails	Podrobnosti o studentech.
StudentListResult	Seznam studentů
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

Amount

Objekt

Částka.

Name	Typ	Description
currency	string	Typ měny, který se používá pro hodnotu.
value	number	Hodnota částky.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Popisuje formát odpovědi na chybu.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponseBody

Objekt

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Name	Typ	Description
error	ErrorResponse	Podrobnosti o chybě.

Student Lab Status

Výčet

Stav studentského testovacího prostředí

Hodnota	Description
Active
Disabled
Expired
Pending
Deleted

Student role

Výčet

Role studenta

Hodnota	Description
Student
Admin

StudentDetails

Objekt

Podrobnosti o studentech.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.budget	Amount	Rozpočet studenta
properties.effectiveDate	string (date-time)	Datum přidání studenta do testovacího prostředí
properties.email	string	E-mail studenta
properties.expirationDate	string (date-time)	Datum, kdy je pro tohoto studenta nastavena platnost testovacího prostředí
properties.firstName	string	Křestní jméno
properties.lastName	string	Příjmení
properties.role	Student role	Role studenta
properties.status	Student Lab Status	Stav studentského testovacího prostředí
properties.subscriptionAlias	string	Alias předplatného
properties.subscriptionId	string	ID předplatného
properties.subscriptionInviteLastSentDate	string (date-time)	datum posledního odeslání pozvánky k předplatnému
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

StudentListResult

Objekt

Seznam studentů

Name	Typ	Description
nextLink	string	Odkaz (url) na další stránku výsledků.
value	StudentDetails[]	Seznam studentů.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.