Students - Get

Ссылка

Служба:: Education

Версия API:: 2021-12-01-preview

Получение сведений для конкретного учащегося в указанной лаборатории по псевдониму учащегося

GET 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

Имя	В	Обязательно	Тип	Описание
billingAccountName	path	True	string	Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.
billingProfileName	path	True	string	Идентификатор, который однозначно идентифицирует профиль выставления счетов.
invoiceSectionName	path	True	string	Идентификатор, который однозначно идентифицирует раздел счета.
studentAlias	path	True	string	Псевдоним учащегося.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия : 2021-12-01-preview

Ответы

Имя	Тип	Описание
200 OK	StudentDetails	Сведения о студенте.
Other Status Codes	ErrorResponseBody	Описывает ошибку, если операция не выполнена успешно.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Student

Образец запроса

GET 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


/**
 * Samples for Students Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/Student.json
     */
    /**
     * Sample code: Student.
     * 
     * @param manager Entry point to EducationManager.
     */
    public static void student(com.azure.resourcemanager.education.EducationManager manager) {
        manager.students().getWithResponse("{billingAccountName}", "{billingProfileName}", "{invoiceSectionName}",
            "{studentAlias}", 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 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.get(
        billing_account_name="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
        invoice_section_name="{invoiceSectionName}",
        student_alias="{studentAlias}",
    )
    print(response)


# x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/Student.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"

	"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/Student.json
func ExampleStudentsClient_Get() {
	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().Get(ctx, "{billingAccountName}", "{billingProfileName}", "{invoiceSectionName}", "{studentAlias}", 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),
	// 		SubscriptionAlias: to.Ptr("000000000-0000-0000-0000-00000000000000"),
	// 		SubscriptionID: to.Ptr("000000000-0000-0000-0000-00000000000000"),
	// 		SubscriptionInviteLastSentDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T21:43:54.161Z"); return t}()),
	// 	},
	// }
}

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 Get the details for a specific student in the specified lab by student alias
 *
 * @summary Get the details for a specific student in the specified lab by student alias
 * x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/Student.json
 */
async function student() {
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const invoiceSectionName = "{invoiceSectionName}";
  const studentAlias = "{studentAlias}";
  const credential = new DefaultAzureCredential();
  const client = new EducationManagementClient(credential);
  const result = await client.students.get(
    billingAccountName,
    billingProfileName,
    invoiceSectionName,
    studentAlias
  );
  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

Пример ответа

Код состояния:: 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",
    "subscriptionAlias": "000000000-0000-0000-0000-00000000000000",
    "subscriptionInviteLastSentDate": "2021-11-09T21:43:54.161Z"
  }
}

Определения

Имя	Описание
Amount	Сумма.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorResponse	Описывает формат ответа на ошибку.
ErrorResponseBody	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.
Student Lab Status	Состояние лаборатории учащихся
Student role	Роль учащегося
StudentDetails	Сведения о студенте.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

Amount

Object

Сумма.

Имя	Тип	Описание
currency	string	Тип валюты, используемой для значения.
value	number	Значение суммы.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorResponse

Object

Описывает формат ответа на ошибку.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponseBody

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorResponse	Сведения об ошибке.

Student Lab Status

Перечисление

Состояние лаборатории учащихся

Значение	Описание
Active
Deleted
Disabled
Expired
Pending

Student role

Перечисление

Роль учащегося

Значение	Описание
Admin
Student

StudentDetails

Object

Сведения о студенте.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.budget	Amount	Бюджет учащихся
properties.effectiveDate	string (date-time)	Дата добавления учащегося в лабораторию
properties.email	string	Электронная почта учащегося
properties.expirationDate	string (date-time)	Дата окончания срока действия учащегося из лаборатории.
properties.firstName	string	Имя
properties.lastName	string	Фамилия
properties.role	Student role	Роль учащегося
properties.status	Student Lab Status	Состояние лаборатории учащихся
properties.subscriptionAlias	string	Псевдоним подписки
properties.subscriptionId	string	идентификатор подписки;
properties.subscriptionInviteLastSentDate	string (date-time)	Дата последнего отправки приглашения на подписку
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Students - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Student

Образец запроса

Пример ответа

Определения

Amount

createdByType

ErrorResponse

ErrorResponseBody

Student Lab Status

Student role

StudentDetails

systemData