@azure/arm-education package

Classes

EducationManagementClient

Interfaces

Amount	The amount.
EducationManagementClientOptionalParams	Optional parameters.
ErrorResponse	Describes the format of Error response.
ErrorResponseBody	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
GrantDetails	Grant details.
GrantListResponse	List of Grants info.
Grants	Interface representing a Grants.
GrantsGetOptionalParams	Optional parameters.
GrantsListAllNextOptionalParams	Optional parameters.
GrantsListAllOptionalParams	Optional parameters.
GrantsListNextOptionalParams	Optional parameters.
GrantsListOptionalParams	Optional parameters.
InviteCodeGenerateRequest	invite code generate request.
JoinRequestDetails	join requests.
JoinRequestList	list of join requests.
JoinRequests	Interface representing a JoinRequests.
JoinRequestsApproveOptionalParams	Optional parameters.
JoinRequestsDenyOptionalParams	Optional parameters.
JoinRequestsGetOptionalParams	Optional parameters.
JoinRequestsListNextOptionalParams	Optional parameters.
JoinRequestsListOptionalParams	Optional parameters.
LabDetails	Lab details.
LabListResult	List of labs.
Labs	Interface representing a Labs.
LabsCreateOrUpdateOptionalParams	Optional parameters.
LabsDeleteOptionalParams	Optional parameters.
LabsGenerateInviteCodeOptionalParams	Optional parameters.
LabsGetOptionalParams	Optional parameters.
LabsListAllNextOptionalParams	Optional parameters.
LabsListAllOptionalParams	Optional parameters.
LabsListNextOptionalParams	Optional parameters.
LabsListOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
RedeemInvitationCodeOptionalParams	Optional parameters.
RedeemRequest	redeem request.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
StudentDetails	Student details.
StudentLabDetails	Student lab details.
StudentLabListResult	List of labs.
StudentLabs	Interface representing a StudentLabs.
StudentLabsGetOptionalParams	Optional parameters.
StudentLabsListAllNextOptionalParams	Optional parameters.
StudentLabsListAllOptionalParams	Optional parameters.
StudentListResult	List of students.
Students	Interface representing a Students.
StudentsCreateOrUpdateOptionalParams	Optional parameters.
StudentsDeleteOptionalParams	Optional parameters.
StudentsGetOptionalParams	Optional parameters.
StudentsListNextOptionalParams	Optional parameters.
StudentsListOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
GrantStatus	Defines values for GrantStatus. KnownGrantStatus can be used interchangeably with GrantStatus, this enum contains the known values that the service supports. Known values supported by the service Active Inactive
GrantType	Defines values for GrantType. KnownGrantType can be used interchangeably with GrantType, this enum contains the known values that the service supports. Known values supported by the service Student Academic
GrantsGetResponse	Contains response data for the get operation.
GrantsListAllNextResponse	Contains response data for the listAllNext operation.
GrantsListAllResponse	Contains response data for the listAll operation.
GrantsListNextResponse	Contains response data for the listNext operation.
GrantsListResponse	Contains response data for the list operation.
JoinRequestStatus	Defines values for JoinRequestStatus. KnownJoinRequestStatus can be used interchangeably with JoinRequestStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Denied
JoinRequestsGetResponse	Contains response data for the get operation.
JoinRequestsListNextResponse	Contains response data for the listNext operation.
JoinRequestsListResponse	Contains response data for the list operation.
LabStatus	Defines values for LabStatus. KnownLabStatus can be used interchangeably with LabStatus, this enum contains the known values that the service supports. Known values supported by the service Active Deleted Pending
LabsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
LabsGenerateInviteCodeResponse	Contains response data for the generateInviteCode operation.
LabsGetResponse	Contains response data for the get operation.
LabsListAllNextResponse	Contains response data for the listAllNext operation.
LabsListAllResponse	Contains response data for the listAll operation.
LabsListNextResponse	Contains response data for the listNext operation.
LabsListResponse	Contains response data for the list operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
StudentLabStatus	Defines values for StudentLabStatus. KnownStudentLabStatus can be used interchangeably with StudentLabStatus, this enum contains the known values that the service supports. Known values supported by the service Active Disabled Expired Pending Deleted
StudentLabsGetResponse	Contains response data for the get operation.
StudentLabsListAllNextResponse	Contains response data for the listAllNext operation.
StudentLabsListAllResponse	Contains response data for the listAll operation.
StudentRole	Defines values for StudentRole. KnownStudentRole can be used interchangeably with StudentRole, this enum contains the known values that the service supports. Known values supported by the service Student Admin
StudentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
StudentsGetResponse	Contains response data for the get operation.
StudentsListNextResponse	Contains response data for the listNext operation.
StudentsListResponse	Contains response data for the list operation.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownGrantStatus	Known values of GrantStatus that the service accepts.
KnownGrantType	Known values of GrantType that the service accepts.
KnownJoinRequestStatus	Known values of JoinRequestStatus that the service accepts.
KnownLabStatus	Known values of LabStatus that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownStudentLabStatus	Known values of StudentLabStatus that the service accepts.
KnownStudentRole	Known values of StudentRole that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.