Microsoft.Education (preview:2021-12-01)

2025/09/19 • 21 new, 21 deleted methods

Operations_List (new)
Description :  Lists all of the available Microsoft.Education API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/operations
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Grants_ListAll (new)
Description :  Get a list of grants that Microsoft has provided.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/grants
{
includeAllocatedBudget:
{
Description: May be used to include information about budget that has been allocated. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Grant detail properties. ,
Required: False ,
}
{
offerCap:
{
Description: Offer Cap ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
effectiveDate:
{
Description: Grant Effective Date ,
Format: date-time ,
Required: False ,
}
string ,
offerType:
{
Description: Grant Offer Type ,
Enum:
{
Student: No description available. ,
Academic: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Grant status ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
allocatedBudget:
{
Description: allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Grants_List (new)
Description :  Get details for a specific grant linked to the provided billing account and billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeAllocatedBudget:
{
Description: May be used to include information about budget that has been allocated. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Grant detail properties. ,
Required: False ,
}
{
offerCap:
{
Description: Offer Cap ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
effectiveDate:
{
Description: Grant Effective Date ,
Format: date-time ,
Required: False ,
}
string ,
offerType:
{
Description: Grant Offer Type ,
Enum:
{
Student: No description available. ,
Academic: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Grant status ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
allocatedBudget:
{
Description: allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Grants_Get (new)
Description :  Get details for a specific grant linked to the provided billing account and billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeAllocatedBudget:
{
Description: May be used to include information about budget that has been allocated. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Grant detail properties. ,
Required: False ,
}
{
offerCap:
{
Description: Offer Cap ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
effectiveDate:
{
Description: Grant Effective Date ,
Format: date-time ,
Required: False ,
}
string ,
offerType:
{
Description: Grant Offer Type ,
Enum:
{
Student: No description available. ,
Academic: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Grant status ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
allocatedBudget:
{
Description: allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_ListAll (new)
Description :  Get a list of labs associated with the provided billing account name and billing profile name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/labs
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeBudget:
{
Description: May be used to include budget information. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: May be used to show deleted items. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_List (new)
Description :  Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeBudget:
{
Description: May be used to include budget information. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_Get (new)
Description :  Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeBudget:
{
Description: May be used to include budget information. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_Delete (new)
Description :  Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_CreateOrUpdate (new)
Description :  Create a new lab or update a previously created lab.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to create lab resource. ,
Required: True ,
}
{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_GenerateInviteCode (new)
Description :  Generate invite code for a lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/generateInviteCode
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
onlyUpdateStudentCountParameter:
{
Description: set this flag to true if you want to update student count without generating a new invite code ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to generate invite code. ,
Required: True ,
}
{
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_List (new)
Description :  get student join requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeDenied:
{
Description: Include denied ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of requests. ,
Required: False ,
}
[
{
properties:
{
Description: join request properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name ,
Required: False ,
}
string ,
email:
{
Description: join request email ,
Required: False ,
}
string ,
status:
{
Description: Join request status ,
Enum:
{
Pending: No description available. ,
Denied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_Get (new)
Description :  get student join requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
joinRequestName:
{
Description: The ID that uniquely identifies a join request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: join request properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name ,
Required: False ,
}
string ,
email:
{
Description: join request email ,
Required: False ,
}
string ,
status:
{
Description: Join request status ,
Enum:
{
Pending: No description available. ,
Denied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_Approve (new)
Description :  Approve student joining the redeemable lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}/approve
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
joinRequestName:
{
Description: The ID that uniquely identifies a join request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_Deny (new)
Description :  Deny student joining the redeemable lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}/deny
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
joinRequestName:
{
Description: The ID that uniquely identifies a join request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RedeemInvitationCode (new)
Description :  Redeem invite code to join a redeemable lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Education/redeemInvitationCode
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters to provide redeem code. ,
Required: True ,
}
{
redeemCode:
{
Description: redeem code ,
Required: True ,
}
string ,
firstName:
{
Description: first name of requester ,
Required: True ,
}
string ,
lastName:
{
Description: last name of requester ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_List (new)
Description :  Get a list of details about students that are associated with the specified lab.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: May be used to show deleted items. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of students. ,
Required: False ,
}
[
{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_Get (new)
Description :  Get the details for a specific student in the specified lab by student alias
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
studentAlias:
{
Description: Student alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_Delete (new)
Description :  Delete the specified student based on the student alias.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
studentAlias:
{
Description: Student alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_CreateOrUpdate (new)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
studentAlias:
{
Description: Student alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to update student properties. ,
Required: True ,
}
{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
StudentLabs_ListAll (new)
Description :  Get a list of all labs associated with the caller of the API.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/studentLabs
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Student lab properties. ,
Required: False ,
}
{
displayName:
{
Description: Student lab Display Name ,
Required: False ,
}
string ,
description:
{
Description: Detail description of this lab ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date the lab will expire and by default will be the expiration date for each student in this lab ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: False ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: User Added Date ,
Format: date-time ,
Required: False ,
}
string ,
labScope:
{
Description: Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
StudentLabs_Get (new)
Description :  Get the details for a specified lab associated with the student lab.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/studentLabs/{studentLabName}
{
studentLabName:
{
Description: The ID that uniquely identifies a student lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Student lab properties. ,
Required: False ,
}
{
displayName:
{
Description: Student lab Display Name ,
Required: False ,
}
string ,
description:
{
Description: Detail description of this lab ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date the lab will expire and by default will be the expiration date for each student in this lab ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: False ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: User Added Date ,
Format: date-time ,
Required: False ,
}
string ,
labScope:
{
Description: Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Microsoft.Education API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/operations
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Grants_ListAll (removed)
Description :  Get a list of grants that Microsoft has provided.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/grants
{
includeAllocatedBudget:
{
Description: May be used to include information about budget that has been allocated. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Grant detail properties. ,
Required: False ,
}
{
offerCap:
{
Description: Offer Cap ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
effectiveDate:
{
Description: Grant Effective Date ,
Format: date-time ,
Required: False ,
}
string ,
offerType:
{
Description: Grant Offer Type ,
Enum:
{
Student: No description available. ,
Academic: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Grant status ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
allocatedBudget:
{
Description: allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Grants_List (removed)
Description :  Get details for a specific grant linked to the provided billing account and billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeAllocatedBudget:
{
Description: May be used to include information about budget that has been allocated. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Grant detail properties. ,
Required: False ,
}
{
offerCap:
{
Description: Offer Cap ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
effectiveDate:
{
Description: Grant Effective Date ,
Format: date-time ,
Required: False ,
}
string ,
offerType:
{
Description: Grant Offer Type ,
Enum:
{
Student: No description available. ,
Academic: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Grant status ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
allocatedBudget:
{
Description: allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Grants_Get (removed)
Description :  Get details for a specific grant linked to the provided billing account and billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeAllocatedBudget:
{
Description: May be used to include information about budget that has been allocated. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Grant detail properties. ,
Required: False ,
}
{
offerCap:
{
Description: Offer Cap ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
effectiveDate:
{
Description: Grant Effective Date ,
Format: date-time ,
Required: False ,
}
string ,
offerType:
{
Description: Grant Offer Type ,
Enum:
{
Student: No description available. ,
Academic: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Grant status ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
allocatedBudget:
{
Description: allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_ListAll (removed)
Description :  Get a list of labs associated with the provided billing account name and billing profile name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/labs
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeBudget:
{
Description: May be used to include budget information. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: May be used to show deleted items. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_List (removed)
Description :  Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeBudget:
{
Description: May be used to include budget information. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_Get (removed)
Description :  Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeBudget:
{
Description: May be used to include budget information. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_Delete (removed)
Description :  Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_CreateOrUpdate (removed)
Description :  Create a new lab or update a previously created lab.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to create lab resource. ,
Required: True ,
}
{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Labs_GenerateInviteCode (removed)
Description :  Generate invite code for a lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/generateInviteCode
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
onlyUpdateStudentCountParameter:
{
Description: set this flag to true if you want to update student count without generating a new invite code ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to generate invite code. ,
Required: True ,
}
{
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Get lab response properties. ,
Required: False ,
}
{
displayName:
{
Description: Lab Display Name ,
Required: True ,
}
string ,
budgetPerStudent:
{
Description: Default monetary cap for each student in this lab ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
description:
{
Description: Detail description of this lab ,
Required: True ,
}
string ,
expirationDate:
{
Description: Default expiration date for each student in this lab ,
Format: date-time ,
Required: True ,
}
string ,
effectiveDate:
{
Description: Lab creation date ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of this lab ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
maxStudentCount:
{
Description: the total number of students that can be accepted to the lab. ,
Required: False ,
}
number ,
invitationCode:
{
Description: invitation code for redeemable lab ,
Required: False ,
}
string ,
totalBudget:
{
Description: Total budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAllocatedBudget:
{
Description: Total allocated budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_List (removed)
Description :  get student join requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeDenied:
{
Description: Include denied ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of requests. ,
Required: False ,
}
[
{
properties:
{
Description: join request properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name ,
Required: False ,
}
string ,
email:
{
Description: join request email ,
Required: False ,
}
string ,
status:
{
Description: Join request status ,
Enum:
{
Pending: No description available. ,
Denied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: the link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_Get (removed)
Description :  get student join requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
joinRequestName:
{
Description: The ID that uniquely identifies a join request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: join request properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name ,
Required: False ,
}
string ,
email:
{
Description: join request email ,
Required: False ,
}
string ,
status:
{
Description: Join request status ,
Enum:
{
Pending: No description available. ,
Denied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_Approve (removed)
Description :  Approve student joining the redeemable lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}/approve
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
joinRequestName:
{
Description: The ID that uniquely identifies a join request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
JoinRequests_Deny (removed)
Description :  Deny student joining the redeemable lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}/deny
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
joinRequestName:
{
Description: The ID that uniquely identifies a join request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RedeemInvitationCode (removed)
Description :  Redeem invite code to join a redeemable lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Education/redeemInvitationCode
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters to provide redeem code. ,
Required: True ,
}
{
redeemCode:
{
Description: redeem code ,
Required: True ,
}
string ,
firstName:
{
Description: first name of requester ,
Required: True ,
}
string ,
lastName:
{
Description: last name of requester ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_List (removed)
Description :  Get a list of details about students that are associated with the specified lab.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: May be used to show deleted items. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of students. ,
Required: False ,
}
[
{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_Get (removed)
Description :  Get the details for a specific student in the specified lab by student alias
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
studentAlias:
{
Description: Student alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_Delete (removed)
Description :  Delete the specified student based on the student alias.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
studentAlias:
{
Description: Student alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Students_CreateOrUpdate (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
studentAlias:
{
Description: Student alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to update student properties. ,
Required: True ,
}
{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Get student response properties. ,
Required: False ,
}
{
firstName:
{
Description: First Name ,
Required: True ,
}
string ,
lastName:
{
Description: Last Name ,
Required: True ,
}
string ,
email:
{
Description: Student Email ,
Required: True ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: True ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: True ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date this student is set to expire from the lab. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: Date student was added to the lab ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionAlias:
{
Description: Subscription alias ,
Required: False ,
}
string ,
subscriptionInviteLastSentDate:
{
Description: subscription invite last sent date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
StudentLabs_ListAll (removed)
Description :  Get a list of all labs associated with the caller of the API.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/studentLabs
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of labs. ,
Required: False ,
}
[
{
properties:
{
Description: Student lab properties. ,
Required: False ,
}
{
displayName:
{
Description: Student lab Display Name ,
Required: False ,
}
string ,
description:
{
Description: Detail description of this lab ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date the lab will expire and by default will be the expiration date for each student in this lab ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: False ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: User Added Date ,
Format: date-time ,
Required: False ,
}
string ,
labScope:
{
Description: Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
StudentLabs_Get (removed)
Description :  Get the details for a specified lab associated with the student lab.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Education/studentLabs/{studentLabName}
{
studentLabName:
{
Description: The ID that uniquely identifies a student lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2021-12-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Student lab properties. ,
Required: False ,
}
{
displayName:
{
Description: Student lab Display Name ,
Required: False ,
}
string ,
description:
{
Description: Detail description of this lab ,
Required: False ,
}
string ,
expirationDate:
{
Description: Date the lab will expire and by default will be the expiration date for each student in this lab ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: Student Role ,
Enum:
{
Student: No description available. ,
Admin: No description available. ,
}
,
Required: False ,
}
enum ,
budget:
{
Description: Student Budget ,
Required: False ,
}
{
currency:
{
Description: The type of currency being used for the value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
status:
{
Description: Student Lab Status ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Pending: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: User Added Date ,
Format: date-time ,
Required: False ,
}
string ,
labScope:
{
Description: Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}