Lab Accounts - Create Lab

Service:

Lab Services

API Version:

2018-10-15

Create a lab in a lab account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/createLab?api-version=2018-10-15

URI Parameters

Name	In	Required	Type	Description
labAccountName	path	True	string	The name of the lab Account.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.

Request Body

Name	Required	Type	Description
labCreationParameters	True	LabCreationParameters	Settings related to creating a lab
name	True	string	The name of the resource
environmentSettingCreationParameters		EnvironmentSettingCreationParameters	Settings related to creating an environment setting
location		string	The location of the resource
tags		object	The tags of the resource.

Responses

Name	Type	Description
200 OK		OK
Other Status Codes	CloudError	BadRequest

Security

azure_auth

OAuth2 Implicit Grant

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Access Microsoft Azure

Definitions

Name	Description
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
CreateLabProperties	Properties for creating a managed lab and a default environment setting
EnvironmentSettingCreationParameters	Settings related to creating an environment setting
LabCreationParameters	Settings related to creating a lab
ManagedLabVmSize	The size of the virtual machine
ReferenceVmCreationParameters	Creation parameters for Reference Vm
ResourceSettingCreationParameters	Represents resource specific settings

CloudError

Object

Error from a REST request.

Name	Type	Description
error	CloudErrorBody	Body of an error from a REST request.

CloudErrorBody

Object

Body of an error from a REST request.

Name	Type	Description
code	string
details	CloudErrorBody[]	Inner errors.
message	string
target	string

CreateLabProperties

Object

Properties for creating a managed lab and a default environment setting

Name	Type	Description
environmentSettingCreationParameters	EnvironmentSettingCreationParameters	Settings related to creating an environment setting
labCreationParameters	LabCreationParameters	Settings related to creating a lab
location	string	The location of the resource
name	string	The name of the resource
tags	object	The tags of the resource.

EnvironmentSettingCreationParameters

Object

Settings related to creating an environment setting

Name	Type	Description
resourceSettingCreationParameters	ResourceSettingCreationParameters	The resource specific settings

LabCreationParameters

Object

Settings related to creating a lab

Name	Type	Description
maxUsersInLab	integer (int32)	Maximum number of users allowed in the lab.

ManagedLabVmSize

Enumeration

The size of the virtual machine

Value	Description
Basic	The base VM size
Standard	The standard or default VM size
Performance	The most performant VM size

ReferenceVmCreationParameters

Object

Creation parameters for Reference Vm

Name	Type	Description
password	string	The password of the virtual machine.
userName	string	The username of the virtual machine

ResourceSettingCreationParameters

Object

Represents resource specific settings

Name	Type	Description
galleryImageResourceId	string	The resource id of the gallery image used for creating the virtual machine
location	string	The location where the virtual machine will live
name	string	The name of the resource setting
referenceVmCreationParameters	ReferenceVmCreationParameters	Creation parameters for Reference Vm
size	ManagedLabVmSize	The size of the virtual machine