Students - Create Or Update

Referenz

Dienst:: Education

API-Version:: 2021-12-01-preview

Erstellen und hinzufügen Sie einen neuen Kursteilnehmer zum angegebenen Labor, oder aktualisieren Sie die Details eines vorhandenen Kursteilnehmers in einem Labor. Beachten Sie, dass der Kursteilnehmer über einen gültigen Mandanten verfügen muss, um das Labor zu akzeptieren, nachdem sie dem Lab hinzugefügt wurden.

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-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.
studentAlias	path	True	string	Schüleralias.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Aktuelle Version ist 2021-12-01-Preview

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.budget	True	Amount	Kursteilnehmerbudget
properties.email	True	string	Schüler-E-Mail
properties.expirationDate	True	string (date-time)	Das Datum, an dem dieser Kursteilnehmer festgelegt ist, läuft ab dem Labor ab.
properties.firstName	True	string	First Name (Vorname)
properties.lastName	True	string	Last Name (Nachname)
properties.role	True	Student role	Schülerrolle
properties.subscriptionAlias		string	Abonnementalias
properties.subscriptionInviteLastSentDate		string (date-time)	Datum der letzten Übermittlung der Abonnement-Einladung

Antworten

Name	Typ	Beschreibung
200 OK	StudentDetails	Die Details der Kursteilnehmer wurden erfolgreich aktualisiert.
201 Created	StudentDetails	Die Details des Kursteilnehmers wurden erfolgreich erstellt.
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

Student

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 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"
  }
}

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	Student Lab Status
Student role	Schülerrolle
StudentDetails	Details des Kursteilnehmers.
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
Application
Key
ManagedIdentity
User

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

Student Lab Status

Wert	Beschreibung
Active
Deleted
Disabled
Expired
Pending

Student role

Enumeration

Schülerrolle

Wert	Beschreibung
Admin
Student

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	Student Lab Status
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"

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.

Freigeben über

Students - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Student

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Amount

createdByType

ErrorResponse

ErrorResponseBody

Student Lab Status

Student role

StudentDetails

systemData