Students - Create Or Update

Referencia

Szolgáltatás:: Education

API-verzió:: 2021-12-01-preview

Hozzon létre és vegyen fel egy új tanulót a megadott tesztkörnyezetbe, vagy frissítse egy meglévő tanuló adatait egy tesztkörnyezetben. Vegye figyelembe, hogy a tanulónak érvényes bérlővel kell rendelkeznie ahhoz, hogy elfogadja a labort, miután hozzáadta őket a laborhoz.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
billingAccountName	path	True	string	A számlázási fiókot egyedileg azonosító azonosító.
billingProfileName	path	True	string	A számlázási profilt egyedileg azonosító azonosító.
invoiceSectionName	path	True	string	A számlaszakaszt egyedileg azonosító azonosító.
studentAlias	path	True	string	Tanulói alias.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2021-12-01-preview

Kérelem törzse

Name	Kötelező	Típus	Description
properties.budget	True	Amount	Hallgatói költségvetés
properties.email	True	string	Tanulói e-mail
properties.expirationDate	True	string (date-time)	Az a dátum, amikor a tanuló lejár a laborból.
properties.firstName	True	string	Keresztnév
properties.lastName	True	string	Vezetéknév
properties.role	True	Student role	Tanulói szerepkör
properties.subscriptionAlias		string	Előfizetés aliasa
properties.subscriptionInviteLastSentDate		string (date-time)	előfizetés-meghívás legutóbbi elküldött dátuma

Válaszok

Name	Típus	Description
200 OK	StudentDetails	A diákok adatainak frissítése sikeresen megtörtént.
201 Created	StudentDetails	Sikeresen létrehozta a tanulói adatokat.
Other Status Codes	ErrorResponseBody	Azt a hibát írja le, ha a művelet nem sikeres.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Student

Mintakérelem

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": {
    "firstName": "test",
    "lastName": "user",
    "email": "test@contoso.com",
    "role": "Student",
    "budget": {
      "currency": "USD",
      "value": 100
    },
    "expirationDate": "2021-11-09T22:13:21.795Z"
  }
}


import com.azure.resourcemanager.education.fluent.models.Amount;
import com.azure.resourcemanager.education.fluent.models.StudentDetailsInner;
import com.azure.resourcemanager.education.models.StudentRole;
import java.time.OffsetDateTime;

/**
 * Samples for Students CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/CreateStudent.
     * json
     */
    /**
     * Sample code: Student.
     * 
     * @param manager Entry point to EducationManager.
     */
    public static void student(com.azure.resourcemanager.education.EducationManager manager) {
        manager.students().createOrUpdateWithResponse("{billingAccountName}", "{billingProfileName}",
            "{invoiceSectionName}", "{studentAlias}",
            new StudentDetailsInner().withFirstName("test").withLastName("user").withEmail("test@contoso.com")
                .withRole(StudentRole.STUDENT).withBudget(new Amount().withCurrency("USD").withValue(100.0F))
                .withExpirationDate(OffsetDateTime.parse("2021-11-09T22:13:21.795Z")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.education import EducationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-education
# USAGE
    python create_student.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EducationManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.students.create_or_update(
        billing_account_name="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
        invoice_section_name="{invoiceSectionName}",
        student_alias="{studentAlias}",
        parameters={
            "properties": {
                "budget": {"currency": "USD", "value": 100},
                "email": "test@contoso.com",
                "expirationDate": "2021-11-09T22:13:21.795Z",
                "firstName": "test",
                "lastName": "user",
                "role": "Student",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/CreateStudent.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armeducation_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/education/armeducation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b9b91929c304f8fb44002267b6c98d9fb9dde014/specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/CreateStudent.json
func ExampleStudentsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeducation.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewStudentsClient().CreateOrUpdate(ctx, "{billingAccountName}", "{billingProfileName}", "{invoiceSectionName}", "{studentAlias}", armeducation.StudentDetails{
		Properties: &armeducation.StudentProperties{
			Budget: &armeducation.Amount{
				Currency: to.Ptr("USD"),
				Value:    to.Ptr[float32](100),
			},
			Email:          to.Ptr("test@contoso.com"),
			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T22:13:21.795Z"); return t }()),
			FirstName:      to.Ptr("test"),
			LastName:       to.Ptr("user"),
			Role:           to.Ptr(armeducation.StudentRoleStudent),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StudentDetails = armeducation.StudentDetails{
	// 	Name: to.Ptr("{studentAlias}"),
	// 	Type: to.Ptr("Microsoft.Education/Students"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}"),
	// 	Properties: &armeducation.StudentProperties{
	// 		Budget: &armeducation.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](100),
	// 		},
	// 		EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T21:43:54.161Z"); return t}()),
	// 		Email: to.Ptr("test@contoso.com"),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-09T21:43:54.161Z"); return t}()),
	// 		FirstName: to.Ptr("test"),
	// 		LastName: to.Ptr("user"),
	// 		Role: to.Ptr(armeducation.StudentRoleStudent),
	// 		Status: to.Ptr(armeducation.StudentLabStatusActive),
	// 		SubscriptionID: to.Ptr("000000000-0000-0000-0000-00000000000000"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { EducationManagementClient } = require("@azure/arm-education");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create and add a new student to the specified lab or update the details of an existing student in a lab. Note the student must have a valid tenant to accept the lab after they have been added to lab.
 *
 * @summary Create and add a new student to the specified lab or update the details of an existing student in a lab. Note the student must have a valid tenant to accept the lab after they have been added to lab.
 * x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/CreateStudent.json
 */
async function student() {
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const invoiceSectionName = "{invoiceSectionName}";
  const studentAlias = "{studentAlias}";
  const parameters = {
    budget: { currency: "USD", value: 100 },
    email: "test@contoso.com",
    expirationDate: new Date("2021-11-09T22:13:21.795Z"),
    firstName: "test",
    lastName: "user",
    role: "Student",
  };
  const credential = new DefaultAzureCredential();
  const client = new EducationManagementClient(credential);
  const result = await client.students.createOrUpdate(
    billingAccountName,
    billingProfileName,
    invoiceSectionName,
    studentAlias,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 201

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

Állapotkód:: 200

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

Definíciók

Name	Description
Amount	Az összeg.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorResponse	A hibaválasz formátumát ismerteti.
ErrorResponseBody	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
Student Lab Status	Tanulói tesztkörnyezet állapota
Student role	Tanulói szerepkör
StudentDetails	Tanulói adatok.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Amount

Objektum

Az összeg.

Name	Típus	Description
currency	string	Az értékhez használt pénznem típusa.
value	number	Összegérték.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorResponse

Objektum

A hibaválasz formátumát ismerteti.

Name	Típus	Description
code	string	Hibakód
message	string	A művelet sikertelen voltát jelző hibaüzenet.

ErrorResponseBody

Objektum

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorResponse	A hiba részletei.

Student Lab Status

Enumerálás

Tanulói tesztkörnyezet állapota

Érték	Description
Active
Deleted
Disabled
Expired
Pending

Student role

Enumerálás

Tanulói szerepkör

Érték	Description
Admin
Student

StudentDetails

Objektum

Tanulói adatok.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.budget	Amount	Hallgatói költségvetés
properties.effectiveDate	string (date-time)	A tanuló felvétele a laborba
properties.email	string	Tanulói e-mail
properties.expirationDate	string (date-time)	Az a dátum, amikor a tanuló lejár a laborból.
properties.firstName	string	Keresztnév
properties.lastName	string	Vezetéknév
properties.role	Student role	Tanulói szerepkör
properties.status	Student Lab Status	Tanulói tesztkörnyezet állapota
properties.subscriptionAlias	string	Előfizetés aliasa
properties.subscriptionId	string	Előfizetés azonosítója
properties.subscriptionInviteLastSentDate	string (date-time)	előfizetés-meghívás legutóbbi elküldött dátuma
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Students - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Student

Mintakérelem

Mintaválasz

Definíciók

Amount

createdByType

ErrorResponse

ErrorResponseBody

Student Lab Status

Student role

StudentDetails

systemData