Microsoft.LabServices (stable:2018-10-15)

2025/10/23 • 55 new, 55 deleted methods

ProviderOperations_List (new)
Description :  Result of the request to list REST API operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.LabServices/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operations ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
description:
{
Description: Friendly name of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
GlobalUsers_GetEnvironment (new)
Description :  Gets the virtual machine details
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getEnvironment
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
environmentOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
}
,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=environment)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
environment:
{
Description: Details of the environment ,
Required: False ,
}
{
name:
{
Description: Name of the Environment ,
Required: False ,
}
string ,
description:
{
Description: Description of the Environment ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the environment ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. ,
Required: False ,
}
string ,
virtualMachineDetails:
{
Description: Details of backing DTL virtual machine with compute and network details. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Dtl VM ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: PrivateIp address of the compute VM ,
Required: False ,
}
string ,
userName:
{
Description: Compute VM login user name ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
environmentState:
{
Description: Publishing state of the environment setting Possible values are Creating, Created, Failed ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_GetOperationBatchStatus (new)
Description :  Get batch operation status
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getOperationBatchStatus
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
operationBatchStatusPayload:
{
Description: Payload to get the status of an operation ,
Required: True ,
}
{
urls:
{
Description: The operation url of long running operation ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
items:
{
Description: Gets a collection of items that contain the operation url and status. ,
Required: False ,
}
[
{
operationUrl:
{
Description: status of the long running operation for an environment ,
Required: False ,
}
string ,
status:
{
Description: status of the long running operation for an environment ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_GetOperationStatus (new)
Description :  Gets the status of long running operation
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getOperationStatus
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
operationStatusPayload:
{
Description: Payload to get the status of an operation ,
Required: True ,
}
{
operationUrl:
{
Description: The operation url of long running operation ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: status of the long running operation for an environment ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_GetPersonalPreferences (new)
Description :  Get personal preferences for a user
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getPersonalPreferences
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
personalPreferencesOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
labAccountResourceId:
{
Description: Resource Id of the lab account ,
Required: False ,
}
string ,
addRemove:
{
Description: Enum indicating if user is adding or removing a favorite lab ,
Enum:
{
Add: Indicates that a user is adding a favorite lab ,
Remove: Indicates that a user is removing a favorite lab ,
}
,
Required: False ,
}
enum ,
labResourceId:
{
Description: Resource Id of the lab to add/remove from the favorites list ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id to be used by the cache orchestrator ,
Required: False ,
}
string ,
favoriteLabResourceIds:
{
Description: Array of favorite lab resource ids ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_ListEnvironments (new)
Description :  List Environments for the user
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/listEnvironments
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
listEnvironmentsPayload:
{
Description: Represents the payload to list environments owned by a user ,
Required: True ,
}
{
labId:
{
Description: The resource Id of the lab ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
environments:
{
Description: List of all the environments ,
Required: False ,
}
[
{
name:
{
Description: Name of the Environment ,
Required: False ,
}
string ,
description:
{
Description: Description of the Environment ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the environment ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. ,
Required: False ,
}
string ,
virtualMachineDetails:
{
Description: Details of backing DTL virtual machine with compute and network details. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Dtl VM ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: PrivateIp address of the compute VM ,
Required: False ,
}
string ,
userName:
{
Description: Compute VM login user name ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
environmentState:
{
Description: Publishing state of the environment setting Possible values are Creating, Created, Failed ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_ListLabs (new)
Description :  List labs for the user.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/listLabs
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
labs:
{
Description: List of all the labs ,
Required: False ,
}
[
{
name:
{
Description: Name of the lab ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the lab. ,
Required: False ,
}
string ,
id:
{
Description: The Id of the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: The maximum duration a user can use a VM in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_Register (new)
Description :  Register a user to a managed lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/register
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
registerPayload:
{
Description: Represents payload for Register action. ,
Required: True ,
}
{
registrationCode:
{
Description: The registration code of the lab. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_ResetPassword (new)
Description :  Resets the user password on an environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/resetPassword
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
resetPasswordPayload:
{
Description: Represents the payload for resetting passwords. ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
username:
{
Description: The username for which the password will be reset. ,
Required: False ,
}
string ,
password:
{
Description: The password to assign to the user specified in ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_StartEnvironment (new)
Description :  Starts an environment by starting all resources inside the environment. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/startEnvironment
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
environmentOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_StopEnvironment (new)
Description :  Stops an environment by stopping all resources inside the environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/stopEnvironment
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
environmentOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_ListBySubscription (new)
Description :  List lab accounts in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labaccounts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=sizeConfiguration)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_Get (new)
Description :  Get operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/locations/{locationName}/operations/{operationName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
operationName:
{
Description: The name of the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
error:
{
Description: Error details for the operation in case of a failure. ,
Required: False ,
}
{
code:
{
Description: The error code of the operation error. ,
Required: False ,
}
string ,
message:
{
Description: The error message of the operation error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_ListByResourceGroup (new)
Description :  List lab accounts in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=sizeConfiguration)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_Get (new)
Description :  Get lab account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=sizeConfiguration)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_CreateOrUpdate (new)
Description :  Create or replace an existing Lab Account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labAccount:
{
Description: Represents a lab account. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_Delete (new)
Description :  Delete lab account. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_Update (new)
Description :  Modify properties of lab accounts.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labAccount:
{
Description: Represents a lab account. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_CreateLab (new)
Description :  Create a lab in a lab account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/createLab
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
createLabProperties:
{
Description: Properties for creating a managed lab and a default environment setting ,
Required: True ,
}
{
environmentSettingCreationParameters:
{
Description: Settings related to creating an environment setting ,
Required: False ,
}
{
resourceSettingCreationParameters:
{
Description: The resource specific settings ,
Required: True ,
}
{
location:
{
Description: The location where the virtual machine will live ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: True ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
referenceVmCreationParameters:
{
Description: Creation parameters for Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. ,
Required: True ,
}
string ,
}
,
}
,
}
,
labCreationParameters:
{
Description: Settings related to creating a lab ,
Required: True ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_List (new)
Description :  List gallery images in a given lab account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=author)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_Get (new)
Description :  Get gallery image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=author)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_CreateOrUpdate (new)
Description :  Create or replace an existing Gallery Image.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Represents an image from the Azure Marketplace ,
Required: True ,
}
{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_Delete (new)
Description :  Delete gallery image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_Update (new)
Description :  Modify properties of gallery images.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Represents an image from the Azure Marketplace ,
Required: True ,
}
{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_GetRegionalAvailability (new)
Description :  Get regional availability information for each size category configured under a lab account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/getRegionalAvailability
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
regionalAvailability:
{
Description: Availability information for different size categories per region ,
Required: False ,
}
[
{
region:
{
Description: Corresponding region ,
Required: False ,
}
string ,
sizeAvailabilities:
{
Description: List of all the size information for the region ,
Required: False ,
}
[
{
sizeCategory:
{
Description: The category of the size (Basic, Standard, Performance). ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
isAvailable:
{
Description: Whether or not this size category is available ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_List (new)
Description :  List labs in a given lab account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=maxUsersInLab)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Get (new)
Description :  Get lab
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=maxUsersInLab)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_CreateOrUpdate (new)
Description :  Create or replace an existing Lab.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: Represents a lab. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Delete (new)
Description :  Delete lab. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Update (new)
Description :  Modify properties of labs.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: Represents a lab. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_AddUsers (new)
Description :  Add users to a lab
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/addUsers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
addUsersPayload:
{
Description: Payload for Add Users operation on a Lab. ,
Required: True ,
}
{
emailAddresses:
{
Description: List of user emails addresses to add to the lab. ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_List (new)
Description :  List environment setting in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=publishingState)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Get (new)
Description :  Get environment setting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=publishingState)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_CreateOrUpdate (new)
Description :  Create or replace an existing Environment Setting. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentSetting:
{
Description: Represents settings of an environment, from which environment instances would be created ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Delete (new)
Description :  Delete environment setting. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Update (new)
Description :  Modify properties of environment setting.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentSetting:
{
Description: Represents settings of an environment, from which environment instances would be created ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: False ,
}
{
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: False ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_ClaimAny (new)
Description :  Claims a random environment for a user in an environment settings
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/claimAny
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_List (new)
Description :  List environments in a given environment setting.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=networkInterface)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Get (new)
Description :  Get environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=networkInterface)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_CreateOrUpdate (new)
Description :  Create or replace an existing Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
environment:
{
Description: Represents an environment instance ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Delete (new)
Description :  Delete environment. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Update (new)
Description :  Modify properties of environments.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
environment:
{
Description: Represents an environment instance ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Claim (new)
Description :  Claims the environment and assigns it to the user
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/claim
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_ResetPassword (new)
Description :  Resets the user password on an environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/resetPassword
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
resetPasswordPayload:
{
Description: Represents the payload for resetting passwords. ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
username:
{
Description: The username for which the password will be reset. ,
Required: False ,
}
string ,
password:
{
Description: The password to assign to the user specified in ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Start (new)
Description :  Starts an environment by starting all resources inside the environment. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Stop (new)
Description :  Stops an environment by stopping all resources inside the environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Publish (new)
Description :  Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/publish
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
publishPayload:
{
Description: Payload for Publish operation on EnvironmentSetting. ,
Required: True ,
}
{
useExistingImage:
{
Description: Whether to use existing VM custom image when publishing. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Start (new)
Description :  Starts a template by starting all resources inside the template. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Stop (new)
Description :  Starts a template by starting all resources inside the template. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Register (new)
Description :  Register to managed lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/register
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_List (new)
Description :  List users in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=email)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Get (new)
Description :  Get user
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=email)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_CreateOrUpdate (new)
Description :  Create or replace an existing User.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
user:
{
Description: The User registered to a lab ,
Required: True ,
}
{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Delete (new)
Description :  Delete user. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Update (new)
Description :  Modify properties of users.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
user:
{
Description: The User registered to a lab ,
Required: True ,
}
{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ProviderOperations_List (removed)
Description :  Result of the request to list REST API operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.LabServices/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operations ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
description:
{
Description: Friendly name of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
GlobalUsers_GetEnvironment (removed)
Description :  Gets the virtual machine details
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getEnvironment
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
environmentOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
}
,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=environment)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
environment:
{
Description: Details of the environment ,
Required: False ,
}
{
name:
{
Description: Name of the Environment ,
Required: False ,
}
string ,
description:
{
Description: Description of the Environment ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the environment ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. ,
Required: False ,
}
string ,
virtualMachineDetails:
{
Description: Details of backing DTL virtual machine with compute and network details. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Dtl VM ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: PrivateIp address of the compute VM ,
Required: False ,
}
string ,
userName:
{
Description: Compute VM login user name ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
environmentState:
{
Description: Publishing state of the environment setting Possible values are Creating, Created, Failed ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_GetOperationBatchStatus (removed)
Description :  Get batch operation status
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getOperationBatchStatus
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
operationBatchStatusPayload:
{
Description: Payload to get the status of an operation ,
Required: True ,
}
{
urls:
{
Description: The operation url of long running operation ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
items:
{
Description: Gets a collection of items that contain the operation url and status. ,
Required: False ,
}
[
{
operationUrl:
{
Description: status of the long running operation for an environment ,
Required: False ,
}
string ,
status:
{
Description: status of the long running operation for an environment ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_GetOperationStatus (removed)
Description :  Gets the status of long running operation
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getOperationStatus
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
operationStatusPayload:
{
Description: Payload to get the status of an operation ,
Required: True ,
}
{
operationUrl:
{
Description: The operation url of long running operation ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: status of the long running operation for an environment ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_GetPersonalPreferences (removed)
Description :  Get personal preferences for a user
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/getPersonalPreferences
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
personalPreferencesOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
labAccountResourceId:
{
Description: Resource Id of the lab account ,
Required: False ,
}
string ,
addRemove:
{
Description: Enum indicating if user is adding or removing a favorite lab ,
Enum:
{
Add: Indicates that a user is adding a favorite lab ,
Remove: Indicates that a user is removing a favorite lab ,
}
,
Required: False ,
}
enum ,
labResourceId:
{
Description: Resource Id of the lab to add/remove from the favorites list ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id to be used by the cache orchestrator ,
Required: False ,
}
string ,
favoriteLabResourceIds:
{
Description: Array of favorite lab resource ids ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_ListEnvironments (removed)
Description :  List Environments for the user
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/listEnvironments
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
listEnvironmentsPayload:
{
Description: Represents the payload to list environments owned by a user ,
Required: True ,
}
{
labId:
{
Description: The resource Id of the lab ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
environments:
{
Description: List of all the environments ,
Required: False ,
}
[
{
name:
{
Description: Name of the Environment ,
Required: False ,
}
string ,
description:
{
Description: Description of the Environment ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the environment ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. ,
Required: False ,
}
string ,
virtualMachineDetails:
{
Description: Details of backing DTL virtual machine with compute and network details. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Dtl VM ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: PrivateIp address of the compute VM ,
Required: False ,
}
string ,
userName:
{
Description: Compute VM login user name ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
environmentState:
{
Description: Publishing state of the environment setting Possible values are Creating, Created, Failed ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_ListLabs (removed)
Description :  List labs for the user.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/listLabs
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
labs:
{
Description: List of all the labs ,
Required: False ,
}
[
{
name:
{
Description: Name of the lab ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the lab. ,
Required: False ,
}
string ,
id:
{
Description: The Id of the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: The maximum duration a user can use a VM in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_Register (removed)
Description :  Register a user to a managed lab
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/register
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
registerPayload:
{
Description: Represents payload for Register action. ,
Required: True ,
}
{
registrationCode:
{
Description: The registration code of the lab. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_ResetPassword (removed)
Description :  Resets the user password on an environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/resetPassword
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
resetPasswordPayload:
{
Description: Represents the payload for resetting passwords. ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
username:
{
Description: The username for which the password will be reset. ,
Required: False ,
}
string ,
password:
{
Description: The password to assign to the user specified in ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_StartEnvironment (removed)
Description :  Starts an environment by starting all resources inside the environment. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/startEnvironment
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
environmentOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GlobalUsers_StopEnvironment (removed)
Description :  Stops an environment by stopping all resources inside the environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.LabServices/users/{userName}/stopEnvironment
{
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
environmentOperationsPayload:
{
Description: Represents payload for any Environment operations like get, start, stop, connect ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_ListBySubscription (removed)
Description :  List lab accounts in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labaccounts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=sizeConfiguration)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_Get (removed)
Description :  Get operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/locations/{locationName}/operations/{operationName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
operationName:
{
Description: The name of the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
error:
{
Description: Error details for the operation in case of a failure. ,
Required: False ,
}
{
code:
{
Description: The error code of the operation error. ,
Required: False ,
}
string ,
message:
{
Description: The error message of the operation error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_ListByResourceGroup (removed)
Description :  List lab accounts in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=sizeConfiguration)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_Get (removed)
Description :  Get lab account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=sizeConfiguration)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_CreateOrUpdate (removed)
Description :  Create or replace an existing Lab Account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labAccount:
{
Description: Represents a lab account. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_Delete (removed)
Description :  Delete lab account. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_Update (removed)
Description :  Modify properties of lab accounts.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labAccount:
{
Description: Represents a lab account. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
sizeConfiguration:
{
Description: Represents the size configuration under the lab account ,
Required: False ,
}
{
environmentSizes:
{
Description: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) ,
Required: False ,
}
[
{
name:
{
Description: The size category ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
vmSizes:
{
Description: Represents a set of compute sizes that can serve this given size type ,
Required: False ,
}
[
{
computeSize:
{
Description: Represents the actual compute size, e.g. Standard_A2_v2. ,
Required: False ,
}
string ,
price:
{
Description: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. ,
Format: decimal ,
Required: False ,
}
number ,
numberOfCores:
{
Description: The number of cores a VM of this size has. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: The amount of memory available (in GB). ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
maxPrice:
{
Description: The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier. ,
Format: decimal ,
Required: False ,
}
number ,
minNumberOfCores:
{
Description: The number of cores a VM of this size has. This is the minimum number of cores within this tier. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemory:
{
Description: The amount of memory available (in GB). This is the minimum amount of memory within this tier. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
enabledRegionSelection:
{
Description: Represents if region selection is enabled ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_CreateLab (removed)
Description :  Create a lab in a lab account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/createLab
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
createLabProperties:
{
Description: Properties for creating a managed lab and a default environment setting ,
Required: True ,
}
{
environmentSettingCreationParameters:
{
Description: Settings related to creating an environment setting ,
Required: False ,
}
{
resourceSettingCreationParameters:
{
Description: The resource specific settings ,
Required: True ,
}
{
location:
{
Description: The location where the virtual machine will live ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: True ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
referenceVmCreationParameters:
{
Description: Creation parameters for Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. ,
Required: True ,
}
string ,
}
,
}
,
}
,
labCreationParameters:
{
Description: Settings related to creating a lab ,
Required: True ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_List (removed)
Description :  List gallery images in a given lab account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=author)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_Get (removed)
Description :  Get gallery image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=author)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_CreateOrUpdate (removed)
Description :  Create or replace an existing Gallery Image.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Represents an image from the Azure Marketplace ,
Required: True ,
}
{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_Delete (removed)
Description :  Delete gallery image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImages_Update (removed)
Description :  Modify properties of gallery images.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery Image. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Represents an image from the Azure Marketplace ,
Required: True ,
}
{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The gallery image properties ,
Required: False ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
isOverride:
{
Description: Indicates whether this gallery has been overridden for this lab account ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LabAccounts_GetRegionalAvailability (removed)
Description :  Get regional availability information for each size category configured under a lab account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/getRegionalAvailability
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
regionalAvailability:
{
Description: Availability information for different size categories per region ,
Required: False ,
}
[
{
region:
{
Description: Corresponding region ,
Required: False ,
}
string ,
sizeAvailabilities:
{
Description: List of all the size information for the region ,
Required: False ,
}
[
{
sizeCategory:
{
Description: The category of the size (Basic, Standard, Performance). ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
isAvailable:
{
Description: Whether or not this size category is available ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_List (removed)
Description :  List labs in a given lab account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=maxUsersInLab)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Get (removed)
Description :  Get lab
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=maxUsersInLab)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_CreateOrUpdate (removed)
Description :  Create or replace an existing Lab.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: Represents a lab. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Delete (removed)
Description :  Delete lab. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Update (removed)
Description :  Modify properties of labs.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: Represents a lab. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
maxUsersInLab:
{
Description: Maximum number of users allowed in the lab. ,
Format: int32 ,
Required: False ,
}
integer ,
userQuota:
{
Description: Maximum value MaxUsersInLab can be set to, as specified by the service ,
Format: int32 ,
Required: False ,
}
integer ,
invitationCode:
{
Description: Invitation code that users can use to join a lab. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Object id of the user that created the lab. ,
Required: False ,
}
string ,
usageQuota:
{
Description: Maximum duration a user can use an environment for in the lab. ,
Format: duration ,
Required: False ,
}
string ,
userAccessMode:
{
Description: Lab user access mode (open to all vs. restricted to those listed on the lab). ,
Enum:
{
Restricted: Only users registered with the lab can access VMs. ,
Open: Any user can register with the lab and access its VMs. ,
}
,
Required: False ,
}
enum ,
createdByUserPrincipalName:
{
Description: Lab creator name ,
Required: False ,
}
string ,
createdDate:
{
Description: Creation date for the lab ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_AddUsers (removed)
Description :  Add users to a lab
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/addUsers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
addUsersPayload:
{
Description: Payload for Add Users operation on a Lab. ,
Required: True ,
}
{
emailAddresses:
{
Description: List of user emails addresses to add to the lab. ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_List (removed)
Description :  List environment setting in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=publishingState)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Get (removed)
Description :  Get environment setting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=publishingState)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_CreateOrUpdate (removed)
Description :  Create or replace an existing Environment Setting. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentSetting:
{
Description: Represents settings of an environment, from which environment instances would be created ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Delete (removed)
Description :  Delete environment setting. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Update (removed)
Description :  Modify properties of environment setting.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentSetting:
{
Description: Represents settings of an environment, from which environment instances would be created ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: False ,
}
{
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: False ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment Setting resource ,
Required: False ,
}
{
publishingState:
{
Description: Describes the readiness of this environment setting ,
Enum:
{
Draft: Initial state of an environment setting. ,
Publishing: Currently provisioning resources. ,
Published: All resources are currently provisioned. ,
PublishFailed: Failed to provision all the necessary resources. ,
Scaling: Currently provisioning resources without recreating VM image. ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Describes the user's progress in configuring their environment setting ,
Enum:
{
NotApplicable: User either hasn't started configuring their template or they haven't started the configuration process. ,
Completed: User is finished modifying the template. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the environment and its resource settings ,
Required: False ,
}
string ,
title:
{
Description: Brief title describing the environment and its resource settings ,
Required: False ,
}
string ,
resourceSettings:
{
Description: The resource specific settings ,
Required: True ,
}
{
id:
{
Description: The unique id of the resource setting ,
Required: False ,
}
string ,
galleryImageResourceId:
{
Description: The resource id of the gallery image used for creating the virtual machine ,
Required: False ,
}
string ,
imageName:
{
Description: The name of the image used to created the environment setting ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine ,
Enum:
{
Basic: The base VM size ,
Standard: The standard or default VM size ,
Performance: The most performant VM size ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: The translated compute cores of the virtual machine ,
Format: int32 ,
Required: False ,
}
integer ,
referenceVm:
{
Description: Details specific to Reference Vm ,
Required: True ,
}
{
userName:
{
Description: The username of the virtual machine ,
Required: True ,
}
string ,
password:
{
Description: The password of the virtual machine. This will be set to null in GET resource API ,
Required: False ,
}
string ,
vmStateDetails:
{
Description: The state details for the reference virtual machine. ,
Required: False ,
}
{
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the reference virtual machine. ,
Required: False ,
}
string ,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
}
,
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
}
,
}
,
lastChanged:
{
Description: Time when the template VM was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastPublished:
{
Description: Time when the template VM was last sent for publishing. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_ClaimAny (removed)
Description :  Claims a random environment for a user in an environment settings
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/claimAny
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_List (removed)
Description :  List environments in a given environment setting.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=networkInterface)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Get (removed)
Description :  Get environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=networkInterface)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_CreateOrUpdate (removed)
Description :  Create or replace an existing Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
environment:
{
Description: Represents an environment instance ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Delete (removed)
Description :  Delete environment. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Update (removed)
Description :  Modify properties of environments.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
environment:
{
Description: Represents an environment instance ,
Required: True ,
}
{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Environment resource ,
Required: False ,
}
{
resourceSets:
{
Description: The set of a VM and the setting id it was created for ,
Required: False ,
}
{
vmResourceId:
{
Description: VM resource Id for the environment ,
Required: False ,
}
string ,
resourceSettingId:
{
Description: resourceSettingId for the environment ,
Required: False ,
}
string ,
}
,
claimedByUserObjectId:
{
Description: The AAD object Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserPrincipalId:
{
Description: The user principal Id of the user who has claimed the environment ,
Required: False ,
}
string ,
claimedByUserName:
{
Description: The name or email address of the user who has claimed the environment ,
Required: False ,
}
string ,
isClaimed:
{
Description: Is the environment claimed or not ,
Required: False ,
}
boolean ,
lastKnownPowerState:
{
Description: Last known power state of the environment ,
Required: False ,
}
string ,
networkInterface:
{
Description: Network details of the environment ,
Required: False ,
}
{
privateIpAddress:
{
Description: PrivateIp address of the Compute VM ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Connection information for Linux ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Connection information for Windows ,
Required: False ,
}
string ,
username:
{
Description: Username of the VM ,
Required: False ,
}
string ,
}
,
totalUsage:
{
Description: How long the environment has been used by a lab user ,
Format: duration ,
Required: False ,
}
string ,
passwordLastReset:
{
Description: When the password was last reset on the environment. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Claim (removed)
Description :  Claims the environment and assigns it to the user
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/claim
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_ResetPassword (removed)
Description :  Resets the user password on an environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/resetPassword
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
resetPasswordPayload:
{
Description: Represents the payload for resetting passwords. ,
Required: True ,
}
{
environmentId:
{
Description: The resourceId of the environment ,
Required: True ,
}
string ,
username:
{
Description: The username for which the password will be reset. ,
Required: False ,
}
string ,
password:
{
Description: The password to assign to the user specified in ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Start (removed)
Description :  Starts an environment by starting all resources inside the environment. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environments_Stop (removed)
Description :  Stops an environment by stopping all resources inside the environment This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Publish (removed)
Description :  Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/publish
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
publishPayload:
{
Description: Payload for Publish operation on EnvironmentSetting. ,
Required: True ,
}
{
useExistingImage:
{
Description: Whether to use existing VM custom image when publishing. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Start (removed)
Description :  Starts a template by starting all resources inside the template. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EnvironmentSettings_Stop (removed)
Description :  Starts a template by starting all resources inside the template. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
environmentSettingName:
{
Description: The name of the environment Setting. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Labs_Register (removed)
Description :  Register to managed lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/register
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_List (removed)
Description :  List users in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=email)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Get (removed)
Description :  Get user
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=email)' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_CreateOrUpdate (removed)
Description :  Create or replace an existing User.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
user:
{
Description: The User registered to a lab ,
Required: True ,
}
{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Delete (removed)
Description :  Delete user. This operation can take a while to complete
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Update (removed)
Description :  Modify properties of users.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labAccountName:
{
Description: The name of the lab Account. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user. ,
Required: True ,
}
string ,
user:
{
Description: The User registered to a lab ,
Required: True ,
}
{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: These are the properties for the user registered under a lab. ,
Required: False ,
}
{
email:
{
Description: The user email address, as it was specified during registration. ,
Required: False ,
}
string ,
familyName:
{
Description: The user family name, as it was specified during registration. ,
Required: False ,
}
string ,
givenName:
{
Description: The user given name, as it was specified during registration. ,
Required: False ,
}
string ,
tenantId:
{
Description: The user tenant ID, as it was specified during registration. ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used his VMs in this lab ,
Format: duration ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
latestOperationResult:
{
Description: The details of the latest operation. ex: status, error ,
Required: False ,
}
{
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code on failure. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
requestUri:
{
Description: Request URI of the operation. ,
Required: False ,
}
string ,
httpMethod:
{
Description: The HttpMethod - PUT/POST/DELETE for the operation. ,
Required: False ,
}
string ,
operationUrl:
{
Description: The URL to use to check long-running operation status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Body of an error from a REST request. ,
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}