@azure/arm-education package
Classes
| EducationManagementClient |
Interfaces
| Amount |
The amount. |
| EducationManagementClientOptionalParams |
Optional parameters for the client. |
| 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. |
| GrantDetailProperties |
Grant detail properties |
| GrantDetails |
Grant details. |
| GrantsGetOptionalParams |
Optional parameters. |
| GrantsListAllOptionalParams |
Optional parameters. |
| GrantsListOptionalParams |
Optional parameters. |
| GrantsOperations |
Interface representing a Grants operations. |
| InviteCodeGenerateRequest |
invite code generate request. |
| JoinRequestDetails |
join requests. |
| JoinRequestProperties |
Join request properties. |
| JoinRequestsApproveOptionalParams |
Optional parameters. |
| JoinRequestsDenyOptionalParams |
Optional parameters. |
| JoinRequestsGetOptionalParams |
Optional parameters. |
| JoinRequestsListOptionalParams |
Optional parameters. |
| JoinRequestsOperations |
Interface representing a JoinRequests operations. |
| LabDetails |
Lab details. |
| LabProperties |
Lab detail result properties. |
| LabsCreateOrUpdateOptionalParams |
Optional parameters. |
| LabsDeleteOptionalParams |
Optional parameters. |
| LabsGenerateInviteCodeOptionalParams |
Optional parameters. |
| LabsGetOptionalParams |
Optional parameters. |
| LabsListAllOptionalParams |
Optional parameters. |
| LabsListOptionalParams |
Optional parameters. |
| LabsOperations |
Interface representing a Labs operations. |
| Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
| OperationDisplay |
Localized display information for an 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. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| 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. |
| StudentLabProperties |
Student lab detail properties |
| StudentLabsGetOptionalParams |
Optional parameters. |
| StudentLabsListAllOptionalParams |
Optional parameters. |
| StudentLabsOperations |
Interface representing a StudentLabs operations. |
| StudentProperties |
Student detail properties |
| StudentsCreateOrUpdateOptionalParams |
Optional parameters. |
| StudentsDeleteOptionalParams |
Optional parameters. |
| StudentsGetOptionalParams |
Optional parameters. |
| StudentsListOptionalParams |
Optional parameters. |
| StudentsOperations |
Interface representing a Students operations. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
Type Aliases
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| GrantStatus |
Grant status Known values supported by the serviceActive: Active |
| GrantType |
Grant Offer Type Known values supported by the serviceStudent: Student |
| JoinRequestStatus |
Join request status Known values supported by the servicePending: Pending |
| LabStatus |
The status of this lab Known values supported by the serviceActive: Active |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| StudentLabStatus |
Student Lab Status Known values supported by the serviceActive: Active |
| StudentRole |
Student Role Known values supported by the serviceStudent: Student |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownGrantStatus |
Grant status |
| KnownGrantType |
Grant Offer Type |
| KnownJoinRequestStatus |
Join request status |
| KnownLabStatus |
The status of this lab |
| KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
| KnownStudentLabStatus |
Student Lab Status |
| KnownStudentRole |
Student Role |
| KnownVersions |
The available API versions. |
Functions
| is |
Typeguard for RestError |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor