Students - Create Or Update

Služba:: Education

Verze rozhraní API:: 2021-12-01-preview

Vytvořte a přidejte nového studenta do zadaného testovacího prostředí nebo aktualizujte podrobnosti existujícího studenta v testovacím prostředí. Poznámka: Po přidání do testovacího prostředí musí mít student platného tenanta pro přijetí testovacího prostředí.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
billingAccountName	path	True	string	Název fakturačního účtu.
billingProfileName	path	True	string	Název fakturačního profilu.
invoiceSectionName	path	True	string	Název oddílu faktury.
studentAlias	path	True	string	Studentská přezdívka.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.budget	True	Amount	Rozpočet studenta
properties.email	True	string	E-mail studenta
properties.expirationDate	True	string (date-time)	Datum, kdy je pro tohoto studenta nastavena platnost testovacího prostředí
properties.firstName	True	string	Křestní jméno
properties.lastName	True	string	Příjmení
properties.role	True	StudentRole	Role studenta
properties.subscriptionAlias		string	Alias předplatného
properties.subscriptionInviteLastSentDate		string (date-time)	datum posledního odeslání pozvánky k předplatnému

Odpovědi

Name	Typ	Description
200 OK	StudentDetails	Aktualizace zdroje 'StudentDetails' byla úspěšná
201 Created	StudentDetails	Zdroj 'StudentDetails' vytvoření operace úspěšná
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

Student

Ukázkový požadavek

HTTP

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

{
  "properties": {
    "budget": {
      "currency": "USD",
      "value": 100
    },
    "email": "test@contoso.com",
    "expirationDate": "2021-11-09T22:13:21.795Z",
    "firstName": "test",
    "lastName": "user",
    "role": "Student"
  }
}

Ukázková odpověď

Stavový kód:: 200

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

Stavový kód:: 201

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

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ě.
StudentDetails	Podrobnosti o studentech.
StudentLabStatus	Stav studentského testovacího prostředí
StudentRole	Role studenta
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 (float)	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ě.

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	StudentRole	Role studenta
properties.status	StudentLabStatus	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

StudentLabStatus

Výčet

Stav studentského testovacího prostředí

Hodnota	Description
Active	Aktivní
Disabled	Invalidní
Expired	Platnost vypršela
Pending	Čekající
Deleted	Odstraněno

StudentRole

Výčet

Role studenta

Hodnota	Description
Student	Studenti
Admin	Admin

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.