Microsoft.LabServices (stable:2023-06-07)

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

Images_ListByLabPlan (new)
Description :  Gets all images from galleries attached to a lab plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images
{}

⚐ Response (200)

{
value:
{
Description: The array page of virtual machine images. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_Get (new)
Description :  Gets an image resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images/{imageName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_CreateOrUpdate (new)
Description :  Updates an image resource via PUT. Creating new resources via PUT will not function.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images/{imageName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_Update (new)
Description :  Updates an image resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images/{imageName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Image resource properties ,
Required: False ,
}
{
enabledState:
{
Description: Is the image enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_ListBySubscription (new)
Description :  Returns a list of all lab plans within a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labPlans
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab plans. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of lab plan results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_ListByResourceGroup (new)
Description :  Returns a list of all lab plans for a subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab plans. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of lab plan results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_Get (new)
Description :  Retrieves the properties of a Lab Plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_CreateOrUpdate (new)
Description :  Operation to create or update a Lab Plan resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_Update (new)
Description :  Operation to update a Lab Plan resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Lab plan resource update properties ,
Required: False ,
}
{
defaultConnectionProfile:
{
Description: The default lab connection profile. This can be changed on a lab resource and only provides a default profile. ,
Required: False ,
}
{
webSshAccess:
{
Description: The enabled access level for Web Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
webRdpAccess:
{
Description: The enabled access level for Web Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientSshAccess:
{
Description: The enabled access level for Client Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientRdpAccess:
{
Description: The enabled access level for Client Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultAutoShutdownProfile:
{
Description: The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile. ,
Required: False ,
}
{
shutdownOnDisconnect:
{
Description: Whether shutdown on disconnect is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownWhenNotConnected:
{
Description: Whether a VM will get shutdown when it hasn't been connected to after a period of time. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownOnIdle:
{
Description: Whether a VM will get shutdown when it has idled for a period of time. ,
Enum:
{
None: The VM won't be shut down when it is idle. ,
UserAbsence: The VM will be considered as idle when there is no keyboard or mouse input. ,
LowUsage: The VM will be considered as idle when user is absent and the resource (CPU and disk) consumption is low. ,
}
,
Required: False ,
}
enum ,
disconnectDelay:
{
Description: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
noConnectDelay:
{
Description: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
idleDelay:
{
Description: The amount of time a VM will idle before it is shutdown if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
}
,
defaultNetworkProfile:
{
Description: The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
}
,
allowedRegions:
{
Description: The allowed regions for the lab creator to use when creating labs using this lab plan. ,
Required: False ,
}
[
string ,
]
,
sharedGalleryId:
{
Description: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. ,
Required: False ,
}
string ,
supportInfo:
{
Description: Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan. ,
Required: False ,
}
{
url:
{
Description: Support web address. ,
Required: False ,
}
string ,
email:
{
Description: Support contact email address. ,
Required: False ,
}
string ,
phone:
{
Description: Support contact phone number. ,
Required: False ,
}
string ,
instructions:
{
Description: Support instructions. ,
Required: False ,
}
string ,
}
,
linkedLmsInstance:
{
Description: Base Url of the lms instance this lab plan can link lab rosters against. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_Delete (new)
Description :  Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_SaveImage (new)
Description :  Saves an image from a lab VM to the attached shared image gallery.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/saveImage
{
body:
{
Description: The request body. ,
Required: True ,
}
{
name:
{
Description: The name for the image we create. ,
Required: False ,
}
string ,
labVirtualMachineId:
{
Description: The ID of the lab virtual machine you want to save an image from. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Returns a list of all operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.LabServices/operations
{}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListBySubscription (new)
Description :  Returns a list of all labs for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labs
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListByResourceGroup (new)
Description :  Returns a list of all labs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Get (new)
Description :  Returns the properties of a lab resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_CreateOrUpdate (new)
Description :  Operation to create or update a lab resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Update (new)
Description :  Operation to update a lab resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Lab resource properties ,
Required: False ,
}
{
autoShutdownProfile:
{
Description: The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle. ,
Required: False ,
}
{
shutdownOnDisconnect:
{
Description: Whether shutdown on disconnect is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownWhenNotConnected:
{
Description: Whether a VM will get shutdown when it hasn't been connected to after a period of time. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownOnIdle:
{
Description: Whether a VM will get shutdown when it has idled for a period of time. ,
Enum:
{
None: The VM won't be shut down when it is idle. ,
UserAbsence: The VM will be considered as idle when there is no keyboard or mouse input. ,
LowUsage: The VM will be considered as idle when user is absent and the resource (CPU and disk) consumption is low. ,
}
,
Required: False ,
}
enum ,
disconnectDelay:
{
Description: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
noConnectDelay:
{
Description: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
idleDelay:
{
Description: The amount of time a VM will idle before it is shutdown if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
}
,
connectionProfile:
{
Description: The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open. ,
Required: False ,
}
{
webSshAccess:
{
Description: The enabled access level for Web Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
webRdpAccess:
{
Description: The enabled access level for Web Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientSshAccess:
{
Description: The enabled access level for Client Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientRdpAccess:
{
Description: The enabled access level for Client Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The profile used for creating lab virtual machines. ,
Required: False ,
}
{
createOption:
{
Description: Indicates what lab virtual machines are created from. ,
Enum:
{
Image: An image is used to create all lab user virtual machines. When this option is set, no template VM will be created. ,
TemplateVM: A template VM will be used to create all lab user virtual machines. ,
}
,
Required: True ,
}
enum ,
imageReference:
{
Description: The image configuration for lab virtual machines. ,
Required: True ,
}
{
id:
{
Description: Image resource ID ,
Required: False ,
}
string ,
offer:
{
Description: The image offer if applicable. ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU ,
Required: False ,
}
string ,
version:
{
Description: The image version specified on creation. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. ,
Required: False ,
}
string ,
}
,
osType:
{
Description: The OS type of the image ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU for the lab. Defines the type of virtual machines used in the lab. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
additionalCapabilities:
{
Description: Additional VM capabilities. ,
Required: False ,
}
{
installGpuDrivers:
{
Description: Flag to pre-install dedicated GPU drivers. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
usageQuota:
{
Description: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. ,
Format: duration ,
Required: True ,
}
string ,
useSharedPassword:
{
Description: Enabling this option will use the same password for all user VMs. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
adminUser:
{
Description: Credentials for the admin user on the VM. ,
Required: True ,
}
{
username:
{
Description: The username to use when signing in to lab VMs. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user. This is required for the TemplateVM createOption. ,
Required: False ,
}
string ,
}
,
nonAdminUser:
{
Description: Credentials for the non-admin user on the VM, if one exists. ,
Required: False ,
}
{
username:
{
Description: The username to use when signing in to lab VMs. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user. This is required for the TemplateVM createOption. ,
Required: False ,
}
string ,
}
,
}
,
securityProfile:
{
Description: The lab security profile. ,
Required: False ,
}
{
registrationCode:
{
Description: The registration code for the lab. ,
Required: False ,
}
string ,
openAccess:
{
Description: Whether any user or only specified users can register to a lab. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
rosterProfile:
{
Description: The lab user list management profile. ,
Required: False ,
}
{
activeDirectoryGroupId:
{
Description: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. ,
Required: False ,
}
string ,
ltiContextId:
{
Description: The unique context identifier for the lab in the lms. ,
Required: False ,
}
string ,
lmsInstance:
{
Description: The base URI identifying the lms instance. ,
Required: False ,
}
string ,
ltiClientId:
{
Description: The unique id of the azure lab services tool in the lms. ,
Required: False ,
}
string ,
ltiRosterEndpoint:
{
Description: The uri of the names and roles service endpoint on the lms for the class attached to this lab. ,
Required: False ,
}
string ,
}
,
labPlanId:
{
Description: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. ,
Required: False ,
}
string ,
title:
{
Description: The title of the lab. ,
Required: False ,
}
string ,
description:
{
Description: The description of the lab. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Delete (new)
Description :  Operation to delete a lab resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Publish (new)
Description :  Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/publish
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_SyncGroup (new)
Description :  Action used to manually kick off an AAD group sync job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/syncGroup
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationResults_Get (new)
Description :  Returns an azure operation result.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/operationResults/{operationResultId}
{}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
status:
{
Description: The operation status ,
Enum:
{
NotStarted: The operation has been accepted but hasn't started. ,
InProgress: The operation is running ,
Succeeded: The operation Succeeded ,
Failed: The operation failed ,
Canceled: Not supported yet ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent completion ,
Required: False ,
}
number ,
error:
{
Description: The error for a failure if the operation failed. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_ListByLab (new)
Description :  Returns a list of all schedules for a lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules
{}

⚐ Response (200)

{
value:
{
Description: The array page of schedule results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of schedule results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Get (new)
Description :  Returns the properties of a lab Schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_CreateOrUpdate (new)
Description :  Operation to create or update a lab schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Update (new)
Description :  Operation to update a lab schedule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Schedule resource properties ,
Required: False ,
}
{
startAt:
{
Description: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. ,
Format: date-time ,
Required: False ,
}
string ,
stopAt:
{
Description: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. ,
Format: date-time ,
Required: False ,
}
string ,
recurrencePattern:
{
Description: The recurrence pattern of the scheduled actions. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of the recurrence. ,
Enum:
{
Daily: Schedule will run every days. ,
Weekly: Schedule will run every week on days specified in weekDays. ,
}
,
Required: True ,
}
enum ,
weekDays:
{
Description: The week days the schedule runs. Used for when the Frequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
interval:
{
Description: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. ,
Format: int32 ,
Required: False ,
}
integer ,
expirationDate:
{
Description: When the recurrence will expire. This date is inclusive. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
timeZoneId:
{
Description: The IANA timezone id for the schedule. ,
Required: False ,
}
string ,
notes:
{
Description: Notes for this schedule. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Delete (new)
Description :  Operation to delete a schedule resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_List (new)
Description :  Returns a list of Azure Lab Services resource SKUs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/skus
{}

⚐ Response (200)

{
value:
{
Description: The array page of sku results. ,
Required: False ,
}
[
{
resourceType:
{
Description: The lab services resource type. ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The family of the SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: The scale out/in options of the SKU. ,
Required: False ,
}
{
default:
{
Description: The default capacity for this resource. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: The lowest permitted capacity for this resource. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The highest permitted capacity for this resource. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The localized name of the resource. ,
Enum:
{
None: The capacity is not adjustable in any way. ,
Manual: The user must manually scale this SKU in and out. ,
Automatic: The user is permitted to scale this SKU in and out. ,
}
,
Required: False ,
}
enum ,
}
,
capabilities:
{
Description: The capabilities of the SKU. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capability for a SKU. ,
Required: False ,
}
string ,
value:
{
Description: The value of the capability for a SKU. ,
Required: False ,
}
string ,
}
,
]
,
locations:
{
Description: List of locations that are available for a size. ,
Required: False ,
}
[
string ,
]
,
costs:
{
Description: Metadata for retrieving price info of a lab services SKUs. ,
Required: False ,
}
[
{
meterId:
{
Description: The meter id. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of units charged. ,
Required: False ,
}
number ,
extendedUnit:
{
Description: The extended unit. ,
Required: False ,
}
string ,
}
,
]
,
restrictions:
{
Description: Restrictions of a lab services SKUs. ,
Required: False ,
}
[
{
type:
{
Description: The type of restriction. ,
Enum:
{
Location: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The values of the restriction. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason for the restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of sku results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Usages_ListByLocation (new)
Description :  Returns list of usage per SKU family for the specified subscription in the specified region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/locations/{location}/usages
{}

⚐ Response (200)

{
value:
{
Description: The array page of Usages. ,
Required: False ,
}
[
{
currentValue:
{
Description: The current usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The limit integer. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: The unit details. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name. ,
Required: False ,
}
{
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
skuInstances:
{
Description: The instances of the resource. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The fully qualified arm resource id. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to get the next page of Usage result. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_ListByLab (new)
Description :  Returns a list of all users for a lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users
{}

⚐ Response (200)

{
value:
{
Description: The array page of user results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Get (new)
Description :  Returns the properties of a lab user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_CreateOrUpdate (new)
Description :  Operation to create or update a lab user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Update (new)
Description :  Operation to update a lab user.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: User resource properties ,
Required: False ,
}
{
additionalUsageQuota:
{
Description: The amount of usage quota time the user gets in addition to the lab usage quota. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Delete (new)
Description :  Operation to delete a user resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Invite (new)
Description :  Operation to invite a user to a lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}/invite
{
body:
{
Description: The request body. ,
Required: True ,
}
{
text:
{
Description: Custom text for the invite email. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ListByLab (new)
Description :  Returns a list of all virtual machines for a lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines
{}

⚐ Response (200)

{
value:
{
Description: The array page of virtual machine results. ,
Required: False ,
}
[
{
systemData:
{
Description: System data of the Lab virtual machine. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Virtual machine resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the virtual machine. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The current state of the virtual machine ,
Enum:
{
Stopped: The VM is currently stopped. ,
Starting: The VM is starting. ,
Running: The VM is running. ,
Stopping: The VM is stopping. ,
ResettingPassword: The VM password is being reset. ,
Reimaging: The VM is being reimaged. ,
Redeploying: The VM is being redeployed. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
connectionProfile:
{
Description: Profile for information about connecting to the virtual machine. ,
Required: False ,
}
{
privateIpAddress:
{
Description: The private IP address of the virtual machine. ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Port and host name separated by semicolon for connecting via SSH protocol to the virtual machine. ,
Required: False ,
}
string ,
sshInBrowserUrl:
{
Description: URL for connecting via SSH protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Port and host name separated by semicolon for connecting via RDP protocol to the virtual machine. ,
Required: False ,
}
string ,
rdpInBrowserUrl:
{
Description: URL for connecting via RDP protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
adminUsername:
{
Description: The username used to log on to the virtual machine as admin. ,
Required: False ,
}
string ,
nonAdminUsername:
{
Description: The username used to log on to the virtual machine as non-admin, if one exists. ,
Required: False ,
}
string ,
}
,
claimedByUserId:
{
Description: The lab user ID (not the PUID!) of who claimed the virtual machine. ,
Required: False ,
}
string ,
vmType:
{
Description: The type of this VM resource ,
Enum:
{
User: A user VM ,
Template: A template VM ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of virtual machine results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Get (new)
Description :  Returns the properties for a lab virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}
{}

⚐ Response (200)

{
systemData:
{
Description: System data of the Lab virtual machine. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Virtual machine resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the virtual machine. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The current state of the virtual machine ,
Enum:
{
Stopped: The VM is currently stopped. ,
Starting: The VM is starting. ,
Running: The VM is running. ,
Stopping: The VM is stopping. ,
ResettingPassword: The VM password is being reset. ,
Reimaging: The VM is being reimaged. ,
Redeploying: The VM is being redeployed. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
connectionProfile:
{
Description: Profile for information about connecting to the virtual machine. ,
Required: False ,
}
{
privateIpAddress:
{
Description: The private IP address of the virtual machine. ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Port and host name separated by semicolon for connecting via SSH protocol to the virtual machine. ,
Required: False ,
}
string ,
sshInBrowserUrl:
{
Description: URL for connecting via SSH protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Port and host name separated by semicolon for connecting via RDP protocol to the virtual machine. ,
Required: False ,
}
string ,
rdpInBrowserUrl:
{
Description: URL for connecting via RDP protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
adminUsername:
{
Description: The username used to log on to the virtual machine as admin. ,
Required: False ,
}
string ,
nonAdminUsername:
{
Description: The username used to log on to the virtual machine as non-admin, if one exists. ,
Required: False ,
}
string ,
}
,
claimedByUserId:
{
Description: The lab user ID (not the PUID!) of who claimed the virtual machine. ,
Required: False ,
}
string ,
vmType:
{
Description: The type of this VM resource ,
Enum:
{
User: A user VM ,
Template: A template VM ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Start (new)
Description :  Action to start a lab virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/start
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Stop (new)
Description :  Action to stop a lab virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/stop
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Reimage (new)
Description :  Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/reimage
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Redeploy (new)
Description :  Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/redeploy
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ResetPassword (new)
Description :  Resets a lab virtual machine password.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/resetPassword
{
body:
{
Description: The request body. ,
Required: True ,
}
{
username:
{
Description: The user whose password is being reset ,
Required: True ,
}
string ,
password:
{
Description: The password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_ListByLabPlan (removed)
Description :  Gets all images from galleries attached to a lab plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images
{}

⚐ Response (200)

{
value:
{
Description: The array page of virtual machine images. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_Get (removed)
Description :  Gets an image resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images/{imageName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_CreateOrUpdate (removed)
Description :  Updates an image resource via PUT. Creating new resources via PUT will not function.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images/{imageName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_Update (removed)
Description :  Updates an image resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/images/{imageName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Image resource properties ,
Required: False ,
}
{
enabledState:
{
Description: Is the image enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the image. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Image resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the image. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The image display name. ,
Required: False ,
}
string ,
description:
{
Description: A description of the image. ,
Required: False ,
}
string ,
iconUrl:
{
Description: URL of the image icon. ,
Required: False ,
}
string ,
author:
{
Description: The image author. ,
Required: False ,
}
string ,
osType:
{
Description: The OS Type of the image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
plan:
{
Description: The ID of marketplace plan associated with the image (optional). ,
Required: False ,
}
string ,
termsStatus:
{
Description: The status of image terms of use (enabled = accepted, disabled = not accepted). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
offer:
{
Description: The ID of an offer associated with the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The ID of the publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: The image version. ,
Required: False ,
}
string ,
sharedGalleryId:
{
Description: The ID for the image in the shared gallery. ,
Required: False ,
}
string ,
availableRegions:
{
Description: The available regions of the image in the shared gallery. ,
Required: False ,
}
[
string ,
]
,
osState:
{
Description: The OS State of the image. ,
Enum:
{
Generalized: Image does not contain any machine and user specific information. ,
Specialized: Image contains machine and user specific information. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_ListBySubscription (removed)
Description :  Returns a list of all lab plans within a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labPlans
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab plans. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of lab plan results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_ListByResourceGroup (removed)
Description :  Returns a list of all lab plans for a subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab plans. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of lab plan results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_Get (removed)
Description :  Retrieves the properties of a Lab Plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_CreateOrUpdate (removed)
Description :  Operation to create or update a Lab Plan resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_Update (removed)
Description :  Operation to update a Lab Plan resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Lab plan resource update properties ,
Required: False ,
}
{
defaultConnectionProfile:
{
Description: The default lab connection profile. This can be changed on a lab resource and only provides a default profile. ,
Required: False ,
}
{
webSshAccess:
{
Description: The enabled access level for Web Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
webRdpAccess:
{
Description: The enabled access level for Web Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientSshAccess:
{
Description: The enabled access level for Client Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientRdpAccess:
{
Description: The enabled access level for Client Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultAutoShutdownProfile:
{
Description: The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile. ,
Required: False ,
}
{
shutdownOnDisconnect:
{
Description: Whether shutdown on disconnect is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownWhenNotConnected:
{
Description: Whether a VM will get shutdown when it hasn't been connected to after a period of time. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownOnIdle:
{
Description: Whether a VM will get shutdown when it has idled for a period of time. ,
Enum:
{
None: The VM won't be shut down when it is idle. ,
UserAbsence: The VM will be considered as idle when there is no keyboard or mouse input. ,
LowUsage: The VM will be considered as idle when user is absent and the resource (CPU and disk) consumption is low. ,
}
,
Required: False ,
}
enum ,
disconnectDelay:
{
Description: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
noConnectDelay:
{
Description: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
idleDelay:
{
Description: The amount of time a VM will idle before it is shutdown if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
}
,
defaultNetworkProfile:
{
Description: The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
}
,
allowedRegions:
{
Description: The allowed regions for the lab creator to use when creating labs using this lab plan. ,
Required: False ,
}
[
string ,
]
,
sharedGalleryId:
{
Description: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. ,
Required: False ,
}
string ,
supportInfo:
{
Description: Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan. ,
Required: False ,
}
{
url:
{
Description: Support web address. ,
Required: False ,
}
string ,
email:
{
Description: Support contact email address. ,
Required: False ,
}
string ,
phone:
{
Description: Support contact phone number. ,
Required: False ,
}
string ,
instructions:
{
Description: Support instructions. ,
Required: False ,
}
string ,
}
,
linkedLmsInstance:
{
Description: Base Url of the lms instance this lab plan can link lab rosters against. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab plan. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab plan resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab plan. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Managed Identity Information ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_Delete (removed)
Description :  Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LabPlans_SaveImage (removed)
Description :  Saves an image from a lab VM to the attached shared image gallery.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}/saveImage
{
body:
{
Description: The request body. ,
Required: True ,
}
{
name:
{
Description: The name for the image we create. ,
Required: False ,
}
string ,
labVirtualMachineId:
{
Description: The ID of the lab virtual machine you want to save an image from. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Returns a list of all operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.LabServices/operations
{}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListBySubscription (removed)
Description :  Returns a list of all labs for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labs
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListByResourceGroup (removed)
Description :  Returns a list of all labs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs
{}

⚐ Response (200)

{
value:
{
Description: The array page of lab results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Get (removed)
Description :  Returns the properties of a lab resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_CreateOrUpdate (removed)
Description :  Operation to create or update a lab resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Update (removed)
Description :  Operation to update a lab resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Lab resource properties ,
Required: False ,
}
{
autoShutdownProfile:
{
Description: The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle. ,
Required: False ,
}
{
shutdownOnDisconnect:
{
Description: Whether shutdown on disconnect is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownWhenNotConnected:
{
Description: Whether a VM will get shutdown when it hasn't been connected to after a period of time. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownOnIdle:
{
Description: Whether a VM will get shutdown when it has idled for a period of time. ,
Enum:
{
None: The VM won't be shut down when it is idle. ,
UserAbsence: The VM will be considered as idle when there is no keyboard or mouse input. ,
LowUsage: The VM will be considered as idle when user is absent and the resource (CPU and disk) consumption is low. ,
}
,
Required: False ,
}
enum ,
disconnectDelay:
{
Description: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
noConnectDelay:
{
Description: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
idleDelay:
{
Description: The amount of time a VM will idle before it is shutdown if this behavior is enabled. ,
Format: duration ,
Required: False ,
}
string ,
}
,
connectionProfile:
{
Description: The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open. ,
Required: False ,
}
{
webSshAccess:
{
Description: The enabled access level for Web Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
webRdpAccess:
{
Description: The enabled access level for Web Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientSshAccess:
{
Description: The enabled access level for Client Access over SSH. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
clientRdpAccess:
{
Description: The enabled access level for Client Access over RDP. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The profile used for creating lab virtual machines. ,
Required: False ,
}
{
createOption:
{
Description: Indicates what lab virtual machines are created from. ,
Enum:
{
Image: An image is used to create all lab user virtual machines. When this option is set, no template VM will be created. ,
TemplateVM: A template VM will be used to create all lab user virtual machines. ,
}
,
Required: True ,
}
enum ,
imageReference:
{
Description: The image configuration for lab virtual machines. ,
Required: True ,
}
{
id:
{
Description: Image resource ID ,
Required: False ,
}
string ,
offer:
{
Description: The image offer if applicable. ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU ,
Required: False ,
}
string ,
version:
{
Description: The image version specified on creation. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. ,
Required: False ,
}
string ,
}
,
osType:
{
Description: The OS type of the image ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU for the lab. Defines the type of virtual machines used in the lab. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
additionalCapabilities:
{
Description: Additional VM capabilities. ,
Required: False ,
}
{
installGpuDrivers:
{
Description: Flag to pre-install dedicated GPU drivers. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
usageQuota:
{
Description: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. ,
Format: duration ,
Required: True ,
}
string ,
useSharedPassword:
{
Description: Enabling this option will use the same password for all user VMs. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
adminUser:
{
Description: Credentials for the admin user on the VM. ,
Required: True ,
}
{
username:
{
Description: The username to use when signing in to lab VMs. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user. This is required for the TemplateVM createOption. ,
Required: False ,
}
string ,
}
,
nonAdminUser:
{
Description: Credentials for the non-admin user on the VM, if one exists. ,
Required: False ,
}
{
username:
{
Description: The username to use when signing in to lab VMs. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user. This is required for the TemplateVM createOption. ,
Required: False ,
}
string ,
}
,
}
,
securityProfile:
{
Description: The lab security profile. ,
Required: False ,
}
{
registrationCode:
{
Description: The registration code for the lab. ,
Required: False ,
}
string ,
openAccess:
{
Description: Whether any user or only specified users can register to a lab. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
rosterProfile:
{
Description: The lab user list management profile. ,
Required: False ,
}
{
activeDirectoryGroupId:
{
Description: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. ,
Required: False ,
}
string ,
ltiContextId:
{
Description: The unique context identifier for the lab in the lms. ,
Required: False ,
}
string ,
lmsInstance:
{
Description: The base URI identifying the lms instance. ,
Required: False ,
}
string ,
ltiClientId:
{
Description: The unique id of the azure lab services tool in the lms. ,
Required: False ,
}
string ,
ltiRosterEndpoint:
{
Description: The uri of the names and roles service endpoint on the lms for the class attached to this lab. ,
Required: False ,
}
string ,
}
,
labPlanId:
{
Description: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. ,
Required: False ,
}
string ,
title:
{
Description: The title of the lab. ,
Required: False ,
}
string ,
description:
{
Description: The description of the lab. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the lab. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Lab resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the lab. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created. ,
Required: False ,
}
{
subnetId:
{
Description: The external subnet resource id ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The external load balancer resource id ,
Required: False ,
}
string ,
publicIpId:
{
Description: The external public IP resource id ,
Required: False ,
}
string ,
}
,
state:
{
Description: The lab state. ,
Enum:
{
Draft: The lab is currently in draft (has not been published). ,
Publishing: The lab is publishing. ,
Scaling: The lab is scaling. ,
Syncing: The lab is syncing users. ,
Published: The lab has been published. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Delete (removed)
Description :  Operation to delete a lab resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Publish (removed)
Description :  Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/publish
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_SyncGroup (removed)
Description :  Action used to manually kick off an AAD group sync job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/syncGroup
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationResults_Get (removed)
Description :  Returns an azure operation result.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/operationResults/{operationResultId}
{}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
status:
{
Description: The operation status ,
Enum:
{
NotStarted: The operation has been accepted but hasn't started. ,
InProgress: The operation is running ,
Succeeded: The operation Succeeded ,
Failed: The operation failed ,
Canceled: Not supported yet ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent completion ,
Required: False ,
}
number ,
error:
{
Description: The error for a failure if the operation failed. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_ListByLab (removed)
Description :  Returns a list of all schedules for a lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules
{}

⚐ Response (200)

{
value:
{
Description: The array page of schedule results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of schedule results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Get (removed)
Description :  Returns the properties of a lab Schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_CreateOrUpdate (removed)
Description :  Operation to create or update a lab schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Update (removed)
Description :  Operation to update a lab schedule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: Schedule resource properties ,
Required: False ,
}
{
startAt:
{
Description: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. ,
Format: date-time ,
Required: False ,
}
string ,
stopAt:
{
Description: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. ,
Format: date-time ,
Required: False ,
}
string ,
recurrencePattern:
{
Description: The recurrence pattern of the scheduled actions. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of the recurrence. ,
Enum:
{
Daily: Schedule will run every days. ,
Weekly: Schedule will run every week on days specified in weekDays. ,
}
,
Required: True ,
}
enum ,
weekDays:
{
Description: The week days the schedule runs. Used for when the Frequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
interval:
{
Description: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. ,
Format: int32 ,
Required: False ,
}
integer ,
expirationDate:
{
Description: When the recurrence will expire. This date is inclusive. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
timeZoneId:
{
Description: The IANA timezone id for the schedule. ,
Required: False ,
}
string ,
notes:
{
Description: Notes for this schedule. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the schedule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Schedule resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the schedule. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on schedule. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Delete (removed)
Description :  Operation to delete a schedule resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_List (removed)
Description :  Returns a list of Azure Lab Services resource SKUs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/skus
{}

⚐ Response (200)

{
value:
{
Description: The array page of sku results. ,
Required: False ,
}
[
{
resourceType:
{
Description: The lab services resource type. ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The family of the SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: The scale out/in options of the SKU. ,
Required: False ,
}
{
default:
{
Description: The default capacity for this resource. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: The lowest permitted capacity for this resource. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The highest permitted capacity for this resource. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The localized name of the resource. ,
Enum:
{
None: The capacity is not adjustable in any way. ,
Manual: The user must manually scale this SKU in and out. ,
Automatic: The user is permitted to scale this SKU in and out. ,
}
,
Required: False ,
}
enum ,
}
,
capabilities:
{
Description: The capabilities of the SKU. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capability for a SKU. ,
Required: False ,
}
string ,
value:
{
Description: The value of the capability for a SKU. ,
Required: False ,
}
string ,
}
,
]
,
locations:
{
Description: List of locations that are available for a size. ,
Required: False ,
}
[
string ,
]
,
costs:
{
Description: Metadata for retrieving price info of a lab services SKUs. ,
Required: False ,
}
[
{
meterId:
{
Description: The meter id. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of units charged. ,
Required: False ,
}
number ,
extendedUnit:
{
Description: The extended unit. ,
Required: False ,
}
string ,
}
,
]
,
restrictions:
{
Description: Restrictions of a lab services SKUs. ,
Required: False ,
}
[
{
type:
{
Description: The type of restriction. ,
Enum:
{
Location: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The values of the restriction. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason for the restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of sku results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Usages_ListByLocation (removed)
Description :  Returns list of usage per SKU family for the specified subscription in the specified region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LabServices/locations/{location}/usages
{}

⚐ Response (200)

{
value:
{
Description: The array page of Usages. ,
Required: False ,
}
[
{
currentValue:
{
Description: The current usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The limit integer. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: The unit details. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name. ,
Required: False ,
}
{
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
skuInstances:
{
Description: The instances of the resource. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The fully qualified arm resource id. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to get the next page of Usage result. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_ListByLab (removed)
Description :  Returns a list of all users for a lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users
{}

⚐ Response (200)

{
value:
{
Description: The array page of user results. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of image results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Get (removed)
Description :  Returns the properties of a lab user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_CreateOrUpdate (removed)
Description :  Operation to create or update a lab user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Update (removed)
Description :  Operation to update a lab user.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{
body:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: User resource properties ,
Required: False ,
}
{
additionalUsageQuota:
{
Description: The amount of usage quota time the user gets in addition to the lab usage quota. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the user resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: User resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the user resource. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name of the user, for example user's full name. ,
Required: False ,
}
string ,
email:
{
Description: Email address of the user. ,
Required: True ,
}
string ,
registrationState:
{
Description: State of the user's registration within the lab. ,
Enum:
{
NotRegistered: User has registered with the lab. ,
Registered: User has not yet registered with the lab. ,
}
,
Required: False ,
}
enum ,
invitationState:
{
Description: State of the invitation message for the user. ,
Enum:
{
NotSent: The invitation has not been sent. ,
Sending: Currently sending the invitation. ,
Sent: The invitation has been successfully sent. ,
Failed: There was an error while sending the invitation. ,
}
,
Required: False ,
}
enum ,
invitationSent:
{
Description: Date and time when the invitation message was sent to the user. ,
Format: date-time ,
Required: False ,
}
string ,
totalUsage:
{
Description: How long the user has used their virtual machines in this lab. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Delete (removed)
Description :  Operation to delete a user resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Invite (removed)
Description :  Operation to invite a user to a lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}/invite
{
body:
{
Description: The request body. ,
Required: True ,
}
{
text:
{
Description: Custom text for the invite email. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ListByLab (removed)
Description :  Returns a list of all virtual machines for a lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines
{}

⚐ Response (200)

{
value:
{
Description: The array page of virtual machine results. ,
Required: False ,
}
[
{
systemData:
{
Description: System data of the Lab virtual machine. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Virtual machine resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the virtual machine. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The current state of the virtual machine ,
Enum:
{
Stopped: The VM is currently stopped. ,
Starting: The VM is starting. ,
Running: The VM is running. ,
Stopping: The VM is stopping. ,
ResettingPassword: The VM password is being reset. ,
Reimaging: The VM is being reimaged. ,
Redeploying: The VM is being redeployed. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
connectionProfile:
{
Description: Profile for information about connecting to the virtual machine. ,
Required: False ,
}
{
privateIpAddress:
{
Description: The private IP address of the virtual machine. ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Port and host name separated by semicolon for connecting via SSH protocol to the virtual machine. ,
Required: False ,
}
string ,
sshInBrowserUrl:
{
Description: URL for connecting via SSH protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Port and host name separated by semicolon for connecting via RDP protocol to the virtual machine. ,
Required: False ,
}
string ,
rdpInBrowserUrl:
{
Description: URL for connecting via RDP protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
adminUsername:
{
Description: The username used to log on to the virtual machine as admin. ,
Required: False ,
}
string ,
nonAdminUsername:
{
Description: The username used to log on to the virtual machine as non-admin, if one exists. ,
Required: False ,
}
string ,
}
,
claimedByUserId:
{
Description: The lab user ID (not the PUID!) of who claimed the virtual machine. ,
Required: False ,
}
string ,
vmType:
{
Description: The type of this VM resource ,
Enum:
{
User: A user VM ,
Template: A template VM ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to get the next page of virtual machine results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Get (removed)
Description :  Returns the properties for a lab virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}
{}

⚐ Response (200)

{
systemData:
{
Description: System data of the Lab virtual machine. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Virtual machine resource properties ,
Required: True ,
}
{
provisioningState:
{
Description: Current provisioning state of the virtual machine. ,
Enum:
{
Creating: Resource is in the process of being created. ,
Updating: New property values are being applied to the resource. ,
Deleting: Resource is in the process of being deleted. ,
Succeeded: Resource is in healthy state after creation or update operation. ,
Failed: Previous operation on the resource has failed leaving resource in unhealthy state. ,
Locked: The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The current state of the virtual machine ,
Enum:
{
Stopped: The VM is currently stopped. ,
Starting: The VM is starting. ,
Running: The VM is running. ,
Stopping: The VM is stopping. ,
ResettingPassword: The VM password is being reset. ,
Reimaging: The VM is being reimaged. ,
Redeploying: The VM is being redeployed. ,
}
,
Required: False ,
}
enum ,
resourceOperationError:
{
Description: Error details of last operation done on lab plan. ,
Required: False ,
}
{
timestamp:
{
Description: The datetime of when the error occured ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: The code that corresponds to the type of operation failure ,
Required: False ,
}
string ,
message:
{
Description: The operation failure message ,
Required: False ,
}
string ,
action:
{
Description: The operation action that failed ,
Required: False ,
}
string ,
}
,
connectionProfile:
{
Description: Profile for information about connecting to the virtual machine. ,
Required: False ,
}
{
privateIpAddress:
{
Description: The private IP address of the virtual machine. ,
Required: False ,
}
string ,
sshAuthority:
{
Description: Port and host name separated by semicolon for connecting via SSH protocol to the virtual machine. ,
Required: False ,
}
string ,
sshInBrowserUrl:
{
Description: URL for connecting via SSH protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: Port and host name separated by semicolon for connecting via RDP protocol to the virtual machine. ,
Required: False ,
}
string ,
rdpInBrowserUrl:
{
Description: URL for connecting via RDP protocol to the virtual machine in browser. ,
Required: False ,
}
string ,
adminUsername:
{
Description: The username used to log on to the virtual machine as admin. ,
Required: False ,
}
string ,
nonAdminUsername:
{
Description: The username used to log on to the virtual machine as non-admin, if one exists. ,
Required: False ,
}
string ,
}
,
claimedByUserId:
{
Description: The lab user ID (not the PUID!) of who claimed the virtual machine. ,
Required: False ,
}
string ,
vmType:
{
Description: The type of this VM resource ,
Enum:
{
User: A user VM ,
Template: A template VM ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Start (removed)
Description :  Action to start a lab virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/start
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Stop (removed)
Description :  Action to stop a lab virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/stop
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Reimage (removed)
Description :  Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/reimage
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Redeploy (removed)
Description :  Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/redeploy
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ResetPassword (removed)
Description :  Resets a lab virtual machine password.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines/{virtualMachineName}/resetPassword
{
body:
{
Description: The request body. ,
Required: True ,
}
{
username:
{
Description: The user whose password is being reset ,
Required: True ,
}
string ,
password:
{
Description: The password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}