@azure/arm-education 1.0.0-beta.4 → 1.0.0-beta.5

package/dist/browser/models/models.d.ts

@@ -0,0 +1,597 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** redeem request. */
+export interface RedeemRequest {
+    /** redeem code */
+    redeemCode: string;
+    /** first name of requester */
+    firstName: string;
+    /** last name of requester */
+    lastName: string;
+}
+export declare function redeemRequestSerializer(item: RedeemRequest): any;
+/** Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. */
+export interface ErrorResponseBody {
+    /** The details of the error. */
+    error?: ErrorResponse;
+}
+export declare function errorResponseBodyDeserializer(item: any): ErrorResponseBody;
+/** Describes the format of Error response. */
+export interface ErrorResponse {
+    /** Error code */
+    code?: string;
+    /** Error message indicating why the operation failed. */
+    message?: string;
+}
+export declare function errorResponseDeserializer(item: any): ErrorResponse;
+/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export interface OperationListResult {
+    /** The Operation items on this page */
+    readonly value: Operation[];
+    /** The link to the next page of items */
+    readonly nextLink?: string;
+}
+export declare function operationListResultDeserializer(item: any): OperationListResult;
+export declare function operationArrayDeserializer(result: Array<Operation>): any[];
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export interface Operation {
+    /** The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" */
+    readonly name?: string;
+    /** Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations. */
+    readonly isDataAction?: boolean;
+    /** Localized display information for this particular operation. */
+    display?: OperationDisplay;
+    /** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+    readonly origin?: Origin;
+    /** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+    readonly actionType?: ActionType;
+}
+export declare function operationDeserializer(item: any): Operation;
+/** Localized display information for an operation. */
+export interface OperationDisplay {
+    /** The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". */
+    readonly provider?: string;
+    /** The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". */
+    readonly resource?: string;
+    /** The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". */
+    readonly operation?: string;
+    /** The short, localized friendly description of the operation; suitable for tool tips and detailed views. */
+    readonly description?: string;
+}
+export declare function operationDisplayDeserializer(item: any): OperationDisplay;
+/** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+export declare enum KnownOrigin {
+    /** Indicates the operation is initiated by a user. */
+    User = "user",
+    /** Indicates the operation is initiated by a system. */
+    System = "system",
+    /** Indicates the operation is initiated by a user or system. */
+    UserSystem = "user,system"
+}
+/**
+ * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" \
+ * {@link KnownOrigin} can be used interchangeably with Origin,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **user**: Indicates the operation is initiated by a user. \
+ * **system**: Indicates the operation is initiated by a system. \
+ * **user,system**: Indicates the operation is initiated by a user or system.
+ */
+export type Origin = string;
+/** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+export declare enum KnownActionType {
+    /** Actions are for internal-only APIs. */
+    Internal = "Internal"
+}
+/**
+ * Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. \
+ * {@link KnownActionType} can be used interchangeably with ActionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Internal**: Actions are for internal-only APIs.
+ */
+export type ActionType = string;
+/** Grant details. */
+export interface GrantDetails extends ProxyResource {
+    /** Offer Cap */
+    readonly offerCap?: Amount;
+    /** Grant Effective Date */
+    readonly effectiveDate?: Date;
+    /** Grant Offer Type */
+    readonly offerType?: GrantType;
+    /** Expiration Date */
+    readonly expirationDate?: Date;
+    /** Grant status */
+    readonly status?: GrantStatus;
+    /** allocated budget */
+    readonly allocatedBudget?: Amount;
+}
+export declare function grantDetailsDeserializer(item: any): GrantDetails;
+/** Grant detail properties */
+export interface GrantDetailProperties {
+    /** Offer Cap */
+    readonly offerCap?: Amount;
+    /** Grant Effective Date */
+    readonly effectiveDate?: Date;
+    /** Grant Offer Type */
+    readonly offerType?: GrantType;
+    /** Expiration Date */
+    readonly expirationDate?: Date;
+    /** Grant status */
+    readonly status?: GrantStatus;
+    /** allocated budget */
+    readonly allocatedBudget?: Amount;
+}
+export declare function grantDetailPropertiesDeserializer(item: any): GrantDetailProperties;
+/** The amount. */
+export interface Amount {
+    /** The type of currency being used for the value. */
+    currency?: string;
+    /** Amount value. */
+    value?: number;
+}
+export declare function amountSerializer(item: Amount): any;
+export declare function amountDeserializer(item: any): Amount;
+/** Grant Offer Type */
+export declare enum KnownGrantType {
+    /** Student */
+    Student = "Student",
+    /** Academic */
+    Academic = "Academic"
+}
+/**
+ * Grant Offer Type \
+ * {@link KnownGrantType} can be used interchangeably with GrantType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Student**: Student \
+ * **Academic**: Academic
+ */
+export type GrantType = string;
+/** Grant status */
+export declare enum KnownGrantStatus {
+    /** Active */
+    Active = "Active",
+    /** Inactive */
+    Inactive = "Inactive"
+}
+/**
+ * Grant status \
+ * {@link KnownGrantStatus} can be used interchangeably with GrantStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Active**: Active \
+ * **Inactive**: Inactive
+ */
+export type GrantStatus = string;
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {
+}
+export declare function proxyResourceSerializer(_item: ProxyResource): any;
+export declare function proxyResourceDeserializer(item: any): ProxyResource;
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface Resource {
+    /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */
+    readonly id?: string;
+    /** The name of the resource */
+    readonly name?: string;
+    /** The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */
+    readonly type?: string;
+    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
+    readonly systemData?: SystemData;
+}
+export declare function resourceSerializer(_item: Resource): any;
+export declare function resourceDeserializer(item: any): Resource;
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+export declare function systemDataDeserializer(item: any): SystemData;
+/** The kind of entity that created the resource. */
+export declare enum KnownCreatedByType {
+    /** The entity was created by a user. */
+    User = "User",
+    /** The entity was created by an application. */
+    Application = "Application",
+    /** The entity was created by a managed identity. */
+    ManagedIdentity = "ManagedIdentity",
+    /** The entity was created by a key. */
+    Key = "Key"
+}
+/**
+ * The kind of entity that created the resource. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User**: The entity was created by a user. \
+ * **Application**: The entity was created by an application. \
+ * **ManagedIdentity**: The entity was created by a managed identity. \
+ * **Key**: The entity was created by a key.
+ */
+export type CreatedByType = string;
+/** List of Grants info. */
+export interface _GrantListResponse {
+    /** The GrantDetails items on this page. */
+    readonly value?: GrantDetails[];
+    /** The link to the next page of items. */
+    nextLink?: string;
+}
+export declare function _grantListResponseDeserializer(item: any): _GrantListResponse;
+export declare function grantDetailsArrayDeserializer(result: Array<GrantDetails>): any[];
+/** Lab details. */
+export interface LabDetails extends ProxyResource {
+    /** Lab Display Name */
+    displayName?: string;
+    /** Default monetary cap for each student in this lab */
+    budgetPerStudent?: Amount;
+    /** Detail description of this lab */
+    description?: string;
+    /** Default expiration date for each student in this lab */
+    expirationDate?: Date;
+    /** Lab creation date */
+    readonly effectiveDate?: Date;
+    /** The status of this lab */
+    readonly status?: LabStatus;
+    /** the total number of students that can be accepted to the lab. */
+    readonly maxStudentCount?: number;
+    /** invitation code for redeemable lab */
+    readonly invitationCode?: string;
+    /** Total budget */
+    readonly totalBudget?: Amount;
+    /** Total allocated budget */
+    readonly totalAllocatedBudget?: Amount;
+}
+export declare function labDetailsSerializer(item: LabDetails): any;
+export declare function labDetailsDeserializer(item: any): LabDetails;
+/** Lab detail result properties. */
+export interface LabProperties {
+    /** Lab Display Name */
+    displayName: string;
+    /** Default monetary cap for each student in this lab */
+    budgetPerStudent: Amount;
+    /** Detail description of this lab */
+    description: string;
+    /** Default expiration date for each student in this lab */
+    expirationDate: Date;
+    /** Lab creation date */
+    readonly effectiveDate?: Date;
+    /** The status of this lab */
+    readonly status?: LabStatus;
+    /** the total number of students that can be accepted to the lab. */
+    readonly maxStudentCount?: number;
+    /** invitation code for redeemable lab */
+    readonly invitationCode?: string;
+    /** The type of currency being used for the value. */
+    currency?: string;
+    /** Amount value. */
+    value?: number;
+    /** The type of currency being used for the value. */
+    currencyTotalAllocatedBudgetCurrency?: string;
+    /** Amount value. */
+    valueTotalAllocatedBudgetValue?: number;
+}
+export declare function labPropertiesSerializer(item: LabProperties): any;
+export declare function labPropertiesDeserializer(item: any): LabProperties;
+/** The status of this lab */
+export declare enum KnownLabStatus {
+    /** Active */
+    Active = "Active",
+    /** Deleted */
+    Deleted = "Deleted",
+    /** Pending */
+    Pending = "Pending"
+}
+/**
+ * The status of this lab \
+ * {@link KnownLabStatus} can be used interchangeably with LabStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Active**: Active \
+ * **Deleted**: Deleted \
+ * **Pending**: Pending
+ */
+export type LabStatus = string;
+/** List of Labs info. */
+export interface _LabListResult {
+    /** The LabDetails items on this page. */
+    readonly value?: LabDetails[];
+    /** The link to the next page of items. */
+    nextLink?: string;
+}
+export declare function _labListResultDeserializer(item: any): _LabListResult;
+export declare function labDetailsArraySerializer(result: Array<LabDetails>): any[];
+export declare function labDetailsArrayDeserializer(result: Array<LabDetails>): any[];
+/** invite code generate request. */
+export interface InviteCodeGenerateRequest {
+    /** the total number of students that can be accepted to the lab. */
+    maxStudentCount?: number;
+}
+export declare function inviteCodeGenerateRequestSerializer(item: InviteCodeGenerateRequest): any;
+/** join requests. */
+export interface JoinRequestDetails extends ProxyResource {
+    /** First Name */
+    firstName?: string;
+    /** Last Name */
+    lastName?: string;
+    /** join request email */
+    email?: string;
+    /** Join request status */
+    status?: JoinRequestStatus;
+}
+export declare function joinRequestDetailsDeserializer(item: any): JoinRequestDetails;
+/** Join request properties. */
+export interface JoinRequestProperties {
+    /** First Name */
+    firstName?: string;
+    /** Last Name */
+    lastName?: string;
+    /** join request email */
+    email?: string;
+    /** Join request status */
+    status?: JoinRequestStatus;
+}
+export declare function joinRequestPropertiesDeserializer(item: any): JoinRequestProperties;
+/** Join request status */
+export declare enum KnownJoinRequestStatus {
+    /** Pending */
+    Pending = "Pending",
+    /** Denied */
+    Denied = "Denied"
+}
+/**
+ * Join request status \
+ * {@link KnownJoinRequestStatus} can be used interchangeably with JoinRequestStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Pending**: Pending \
+ * **Denied**: Denied
+ */
+export type JoinRequestStatus = string;
+/** list of join requests. */
+export interface _JoinRequestList {
+    /** The JoinRequestDetails items on this page. */
+    readonly value?: JoinRequestDetails[];
+    /** The link to the next page of items. */
+    nextLink?: string;
+}
+export declare function _joinRequestListDeserializer(item: any): _JoinRequestList;
+export declare function joinRequestDetailsArrayDeserializer(result: Array<JoinRequestDetails>): any[];
+/** Student details. */
+export interface StudentDetails extends ProxyResource {
+    /** First Name */
+    firstName?: string;
+    /** Last Name */
+    lastName?: string;
+    /** Student Email */
+    email?: string;
+    /** Student Role */
+    role?: StudentRole;
+    /** Student Budget */
+    budget?: Amount;
+    /** Subscription Id */
+    readonly subscriptionId?: string;
+    /** Date this student is set to expire from the lab. */
+    expirationDate?: Date;
+    /** Student Lab Status */
+    readonly status?: StudentLabStatus;
+    /** Date student was added to the lab */
+    readonly effectiveDate?: Date;
+    /** Subscription alias */
+    subscriptionAlias?: string;
+    /** subscription invite last sent date */
+    subscriptionInviteLastSentDate?: Date;
+}
+export declare function studentDetailsSerializer(item: StudentDetails): any;
+export declare function studentDetailsDeserializer(item: any): StudentDetails;
+/** Student detail properties */
+export interface StudentProperties {
+    /** First Name */
+    firstName: string;
+    /** Last Name */
+    lastName: string;
+    /** Student Email */
+    email: string;
+    /** Student Role */
+    role: StudentRole;
+    /** Student Budget */
+    budget: Amount;
+    /** Subscription Id */
+    readonly subscriptionId?: string;
+    /** Date this student is set to expire from the lab. */
+    expirationDate: Date;
+    /** Student Lab Status */
+    readonly status?: StudentLabStatus;
+    /** Date student was added to the lab */
+    readonly effectiveDate?: Date;
+    /** Subscription alias */
+    subscriptionAlias?: string;
+    /** subscription invite last sent date */
+    subscriptionInviteLastSentDate?: Date;
+}
+export declare function studentPropertiesSerializer(item: StudentProperties): any;
+export declare function studentPropertiesDeserializer(item: any): StudentProperties;
+/** Student Role */
+export declare enum KnownStudentRole {
+    /** Student */
+    Student = "Student",
+    /** Admin */
+    Admin = "Admin"
+}
+/**
+ * Student Role \
+ * {@link KnownStudentRole} can be used interchangeably with StudentRole,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Student**: Student \
+ * **Admin**: Admin
+ */
+export type StudentRole = string;
+/** Student Lab Status */
+export declare enum KnownStudentLabStatus {
+    /** Active */
+    Active = "Active",
+    /** Disabled */
+    Disabled = "Disabled",
+    /** Expired */
+    Expired = "Expired",
+    /** Pending */
+    Pending = "Pending",
+    /** Deleted */
+    Deleted = "Deleted"
+}
+/**
+ * Student Lab Status \
+ * {@link KnownStudentLabStatus} can be used interchangeably with StudentLabStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Active**: Active \
+ * **Disabled**: Disabled \
+ * **Expired**: Expired \
+ * **Pending**: Pending \
+ * **Deleted**: Deleted
+ */
+export type StudentLabStatus = string;
+/** List of Students info. */
+export interface _StudentListResult {
+    /** The StudentDetails items on this page. */
+    readonly value?: StudentDetails[];
+    /** The link to the next page of items. */
+    nextLink?: string;
+}
+export declare function _studentListResultDeserializer(item: any): _StudentListResult;
+export declare function studentDetailsArraySerializer(result: Array<StudentDetails>): any[];
+export declare function studentDetailsArrayDeserializer(result: Array<StudentDetails>): any[];
+/** Student lab details. */
+export interface StudentLabDetails extends ProxyResource {
+    /** Student lab Display Name */
+    readonly displayName?: string;
+    /** Detail description of this lab */
+    readonly description?: string;
+    /** Date the lab will expire and by default will be the expiration date for each student in this lab */
+    readonly expirationDate?: Date;
+    /** Student Role */
+    readonly role?: StudentRole;
+    /** Student Budget */
+    readonly budget?: Amount;
+    /** Subscription Id */
+    readonly subscriptionId?: string;
+    /** Student Lab Status */
+    readonly status?: StudentLabStatus;
+    /** User Added Date */
+    readonly effectiveDate?: Date;
+    /** Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default */
+    readonly labScope?: string;
+}
+export declare function studentLabDetailsDeserializer(item: any): StudentLabDetails;
+/** Student lab detail properties */
+export interface StudentLabProperties {
+    /** Student lab Display Name */
+    readonly displayName?: string;
+    /** Detail description of this lab */
+    readonly description?: string;
+    /** Date the lab will expire and by default will be the expiration date for each student in this lab */
+    readonly expirationDate?: Date;
+    /** Student Role */
+    readonly role?: StudentRole;
+    /** Student Budget */
+    readonly budget?: Amount;
+    /** Subscription Id */
+    readonly subscriptionId?: string;
+    /** Student Lab Status */
+    readonly status?: StudentLabStatus;
+    /** User Added Date */
+    readonly effectiveDate?: Date;
+    /** Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default */
+    readonly labScope?: string;
+}
+export declare function studentLabPropertiesDeserializer(item: any): StudentLabProperties;
+/** List of Student Labs info. */
+export interface _StudentLabListResult {
+    /** The StudentLabDetails items on this page. */
+    readonly value?: StudentLabDetails[];
+    /** The link to the next page of items. */
+    nextLink?: string;
+}
+export declare function _studentLabListResultDeserializer(item: any): _StudentLabListResult;
+export declare function studentLabDetailsArrayDeserializer(result: Array<StudentLabDetails>): any[];
+/** The available API versions. */
+export declare enum KnownVersions {
+    /** The 2021-12-01-preview API version. */
+    V20211201Preview = "2021-12-01-preview"
+}
+export declare function _grantDetailsPropertiesDeserializer(item: any): {
+    offerCap: any;
+    effectiveDate: any;
+    offerType: any;
+    expirationDate: any;
+    status: any;
+    allocatedBudget: any;
+};
+export declare function _labPropertiesTotalBudgetSerializer(item: LabProperties): any;
+export declare function _labPropertiesTotalBudgetDeserializer(item: any): {
+    currency: any;
+    value: any;
+};
+export declare function _labPropertiesTotalAllocatedBudgetSerializer(item: LabProperties): any;
+export declare function _labPropertiesTotalAllocatedBudgetDeserializer(item: any): {
+    currencyTotalAllocatedBudgetCurrency: any;
+    valueTotalAllocatedBudgetValue: any;
+};
+export declare function _labDetailsPropertiesSerializer(item: LabDetails): any;
+export declare function _labDetailsPropertiesDeserializer(item: any): {
+    displayName: any;
+    budgetPerStudent: any;
+    description: any;
+    expirationDate: any;
+    effectiveDate: any;
+    status: any;
+    maxStudentCount: any;
+    invitationCode: any;
+    totalBudget: any;
+    totalAllocatedBudget: any;
+};
+export declare function _joinRequestDetailsPropertiesDeserializer(item: any): {
+    firstName: any;
+    lastName: any;
+    email: any;
+    status: any;
+};
+export declare function _studentDetailsPropertiesSerializer(item: StudentDetails): any;
+export declare function _studentDetailsPropertiesDeserializer(item: any): {
+    firstName: any;
+    lastName: any;
+    email: any;
+    role: any;
+    budget: any;
+    subscriptionId: any;
+    expirationDate: any;
+    status: any;
+    effectiveDate: any;
+    subscriptionAlias: any;
+    subscriptionInviteLastSentDate: any;
+};
+export declare function _studentLabDetailsPropertiesDeserializer(item: any): {
+    displayName: any;
+    description: any;
+    expirationDate: any;
+    role: any;
+    budget: any;
+    subscriptionId: any;
+    status: any;
+    effectiveDate: any;
+    labScope: any;
+};
+//# sourceMappingURL=models.d.ts.map