azure.mgmt.labservices.models module

class azure.mgmt.labservices.models.ActionType(value)[source]

Bases: str, enum.Enum

Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'
class azure.mgmt.labservices.models.AutoShutdownProfile(*, shutdown_on_disconnect: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, shutdown_when_not_connected: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, shutdown_on_idle: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.ShutdownOnIdleMode]] = None, disconnect_delay: Optional[datetime.timedelta] = None, no_connect_delay: Optional[datetime.timedelta] = None, idle_delay: Optional[datetime.timedelta] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Profile for how to handle shutting down virtual machines.

Variables
  • shutdown_on_disconnect (str or EnableState) – Whether shutdown on disconnect is enabled. Possible values include: “Enabled”, “Disabled”.

  • shutdown_when_not_connected (str or EnableState) – Whether a VM will get shutdown when it hasn’t been connected to after a period of time. Possible values include: “Enabled”, “Disabled”.

  • shutdown_on_idle (str or ShutdownOnIdleMode) – Whether a VM will get shutdown when it has idled for a period of time. Possible values include: “None”, “UserAbsence”, “LowUsage”.

  • disconnect_delay (timedelta) – The amount of time a VM will stay running after a user disconnects if this behavior is enabled.

  • no_connect_delay (timedelta) – The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.

  • idle_delay (timedelta) – The amount of time a VM will idle before it is shutdown if this behavior is enabled.

Keyword Arguments
  • shutdown_on_disconnect (str or EnableState) – Whether shutdown on disconnect is enabled. Possible values include: “Enabled”, “Disabled”.

  • shutdown_when_not_connected (str or EnableState) – Whether a VM will get shutdown when it hasn’t been connected to after a period of time. Possible values include: “Enabled”, “Disabled”.

  • shutdown_on_idle (str or ShutdownOnIdleMode) – Whether a VM will get shutdown when it has idled for a period of time. Possible values include: “None”, “UserAbsence”, “LowUsage”.

  • disconnect_delay (timedelta) – The amount of time a VM will stay running after a user disconnects if this behavior is enabled.

  • no_connect_delay (timedelta) – The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.

  • idle_delay (timedelta) – The amount of time a VM will idle before it is shutdown if this behavior is enabled.

class azure.mgmt.labservices.models.ConnectionProfile(*, web_ssh_access: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.ConnectionType]] = None, web_rdp_access: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.ConnectionType]] = None, client_ssh_access: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.ConnectionType]] = None, client_rdp_access: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.ConnectionType]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Connection profile for how users connect to lab virtual machines.

Variables
  • web_ssh_access (str or ConnectionType) – The enabled access level for Web Access over SSH. Possible values include: “Public”, “Private”, “None”.

  • web_rdp_access (str or ConnectionType) – The enabled access level for Web Access over RDP. Possible values include: “Public”, “Private”, “None”.

  • client_ssh_access (str or ConnectionType) – The enabled access level for Client Access over SSH. Possible values include: “Public”, “Private”, “None”.

  • client_rdp_access (str or ConnectionType) – The enabled access level for Client Access over RDP. Possible values include: “Public”, “Private”, “None”.

Keyword Arguments
  • web_ssh_access (str or ConnectionType) – The enabled access level for Web Access over SSH. Possible values include: “Public”, “Private”, “None”.

  • web_rdp_access (str or ConnectionType) – The enabled access level for Web Access over RDP. Possible values include: “Public”, “Private”, “None”.

  • client_ssh_access (str or ConnectionType) – The enabled access level for Client Access over SSH. Possible values include: “Public”, “Private”, “None”.

  • client_rdp_access (str or ConnectionType) – The enabled access level for Client Access over RDP. Possible values include: “Public”, “Private”, “None”.

class azure.mgmt.labservices.models.ConnectionType(value)[source]

Bases: str, enum.Enum

A connection type for access labs and VMs (Public, Private or None).

NONE = 'None'
PRIVATE = 'Private'
PUBLIC = 'Public'
class azure.mgmt.labservices.models.CreateOption(value)[source]

Bases: str, enum.Enum

Indicates what lab virtual machines are created from.

IMAGE = 'Image'

An image is used to create all lab user virtual machines. When this option is set, no template VM will be created.

TEMPLATE_VM = 'TemplateVM'

A template VM will be used to create all lab user virtual machines.

class azure.mgmt.labservices.models.CreatedByType(value)[source]

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.labservices.models.Credentials(*, username: str, password: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Credentials for a user on a lab VM.

All required parameters must be populated in order to send to Azure.

Variables
  • username (str) – Required. The username to use when signing in to lab VMs.

  • password (str) – The password for the user. This is required for the TemplateVM createOption.

Keyword Arguments
  • username (str) – Required. The username to use when signing in to lab VMs.

  • password (str) – The password for the user. This is required for the TemplateVM createOption.

class azure.mgmt.labservices.models.EnableState(value)[source]

Bases: str, enum.Enum

Property enabled state.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.labservices.models.ErrorAdditionalInfo(**kwargs)[source]

Bases: msrest.serialization.Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • type (str) – The additional info type.

  • info (any) – The additional info.

class azure.mgmt.labservices.models.ErrorDetail(**kwargs)[source]

Bases: msrest.serialization.Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.labservices.models.ErrorResponse(*, error: Optional[azure.mgmt.labservices.models._models_py3.ErrorDetail] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables

error (ErrorDetail) – The error object.

Keyword Arguments

error (ErrorDetail) – The error object.

class azure.mgmt.labservices.models.Image(*, enabled_state: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, available_regions: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.ProxyResource

Lab services virtual machine image.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the image.

  • enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the image. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • display_name (str) – The image display name.

  • description (str) – A description of the image.

  • icon_url (str) – URL of the image icon.

  • author (str) – The image author.

  • os_type (str or OsType) – The OS Type of the image. Possible values include: “Windows”, “Linux”.

  • plan (str) – The ID of marketplace plan associated with the image (optional).

  • terms_status (str or EnableState) – The status of image terms of use (enabled = accepted, disabled = not accepted). Possible values include: “Enabled”, “Disabled”.

  • offer (str) – The ID of an offer associated with the image.

  • publisher (str) – The ID of the publisher of the image.

  • sku (str) – The image SKU.

  • version (str) – The image version.

  • shared_gallery_id (str) – The ID for the image in the shared gallery.

  • available_regions (list[str]) – The available regions of the image in the shared gallery.

  • os_state (str or OsState) – The OS State of the image. Possible values include: “Generalized”, “Specialized”.

Keyword Arguments
  • enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

  • available_regions (list[str]) – The available regions of the image in the shared gallery.

class azure.mgmt.labservices.models.ImageProperties(*, enabled_state: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, available_regions: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.ImageUpdateProperties

Properties of an image resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the image. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • display_name (str) – The image display name.

  • description (str) – A description of the image.

  • icon_url (str) – URL of the image icon.

  • author (str) – The image author.

  • os_type (str or OsType) – The OS Type of the image. Possible values include: “Windows”, “Linux”.

  • plan (str) – The ID of marketplace plan associated with the image (optional).

  • terms_status (str or EnableState) – The status of image terms of use (enabled = accepted, disabled = not accepted). Possible values include: “Enabled”, “Disabled”.

  • offer (str) – The ID of an offer associated with the image.

  • publisher (str) – The ID of the publisher of the image.

  • sku (str) – The image SKU.

  • version (str) – The image version.

  • shared_gallery_id (str) – The ID for the image in the shared gallery.

  • available_regions (list[str]) – The available regions of the image in the shared gallery.

  • os_state (str or OsState) – The OS State of the image. Possible values include: “Generalized”, “Specialized”.

Keyword Arguments
  • enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

  • available_regions (list[str]) – The available regions of the image in the shared gallery.

class azure.mgmt.labservices.models.ImageReference(*, id: Optional[str] = None, offer: Optional[str] = None, publisher: Optional[str] = None, sku: Optional[str] = None, version: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Image reference information. Used in the virtual machine profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Image resource ID.

  • offer (str) – The image offer if applicable.

  • publisher (str) – The image publisher.

  • sku (str) – The image SKU.

  • version (str) – The image version specified on creation.

  • exact_version (str) – The actual version of the image after use.

Keyword Arguments
  • id (str) – Image resource ID.

  • offer (str) – The image offer if applicable.

  • publisher (str) – The image publisher.

  • sku (str) – The image SKU.

  • version (str) – The image version specified on creation.

class azure.mgmt.labservices.models.ImageUpdate(*, enabled_state: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Lab services virtual machine image for updates.

Variables

enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.labservices.models.ImageUpdateProperties(*, enabled_state: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of an image resource update.

Variables

enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

enabled_state (str or EnableState) – Is the image enabled. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.labservices.models.InvitationState(value)[source]

Bases: str, enum.Enum

The lab user invitation state.

FAILED = 'Failed'

There was an error while sending the invitation.

NOT_SENT = 'NotSent'

The invitation has not been sent.

SENDING = 'Sending'

Currently sending the invitation.

SENT = 'Sent'

The invitation has been successfully sent.

class azure.mgmt.labservices.models.InviteBody(*, text: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Body for a user invite request.

Variables

text (str) – Custom text for the invite email.

Keyword Arguments

text (str) – Custom text for the invite email.

class azure.mgmt.labservices.models.Lab(*, location: str, tags: Optional[Dict[str, str]] = None, auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, virtual_machine_profile: Optional[azure.mgmt.labservices.models._models_py3.VirtualMachineProfile] = None, security_profile: Optional[azure.mgmt.labservices.models._models_py3.SecurityProfile] = None, roster_profile: Optional[azure.mgmt.labservices.models._models_py3.RosterProfile] = None, lab_plan_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, network_profile: Optional[azure.mgmt.labservices.models._models_py3.LabNetworkProfile] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.TrackedResource

The lab resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the lab.

  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the lab. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • network_profile (LabNetworkProfile) – The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.

  • state (str or LabState) – The lab state. Possible values include: “Draft”, “Publishing”, “Scaling”, “Syncing”, “Published”.

Keyword Arguments
  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

  • network_profile (LabNetworkProfile) – The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.

class azure.mgmt.labservices.models.LabNetworkProfile(*, subnet_id: Optional[str] = None, load_balancer_id: Optional[str] = None, public_ip_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Profile for how to handle networking for Labs.

Variables
  • subnet_id (str) – The external subnet resource id.

  • load_balancer_id (str) – The external load balancer resource id.

  • public_ip_id (str) – The external public IP resource id.

Keyword Arguments
  • subnet_id (str) – The external subnet resource id.

  • load_balancer_id (str) – The external load balancer resource id.

  • public_ip_id (str) – The external public IP resource id.

class azure.mgmt.labservices.models.LabPlan(*, location: str, tags: Optional[Dict[str, str]] = None, default_connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, default_auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, default_network_profile: Optional[azure.mgmt.labservices.models._models_py3.LabPlanNetworkProfile] = None, allowed_regions: Optional[List[str]] = None, shared_gallery_id: Optional[str] = None, support_info: Optional[azure.mgmt.labservices.models._models_py3.SupportInfo] = None, linked_lms_instance: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.TrackedResource

Lab Plans act as a permission container for creating labs via labs.azure.com. Additionally, they can provide a set of default configurations that will apply at the time of creating a lab, but these defaults can still be overwritten.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the lab plan.

  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the lab plan. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

Keyword Arguments
  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

class azure.mgmt.labservices.models.LabPlanNetworkProfile(*, subnet_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Profile for how to handle networking for Lab Plans.

Variables

subnet_id (str) – The external subnet resource id.

Keyword Arguments

subnet_id (str) – The external subnet resource id.

class azure.mgmt.labservices.models.LabPlanProperties(*, default_connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, default_auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, default_network_profile: Optional[azure.mgmt.labservices.models._models_py3.LabPlanNetworkProfile] = None, allowed_regions: Optional[List[str]] = None, shared_gallery_id: Optional[str] = None, support_info: Optional[azure.mgmt.labservices.models._models_py3.SupportInfo] = None, linked_lms_instance: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.LabPlanUpdateProperties

Lab plan resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the lab plan. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

Keyword Arguments
  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

class azure.mgmt.labservices.models.LabPlanUpdate(*, tags: Optional[List[str]] = None, default_connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, default_auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, default_network_profile: Optional[azure.mgmt.labservices.models._models_py3.LabPlanNetworkProfile] = None, allowed_regions: Optional[List[str]] = None, shared_gallery_id: Optional[str] = None, support_info: Optional[azure.mgmt.labservices.models._models_py3.SupportInfo] = None, linked_lms_instance: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.TrackedResourceUpdate

Contains lab configuration and default settings. This variant is used for PATCH.

Variables
  • tags (list[str]) – A set of tags. Resource tags.

  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

Keyword Arguments
  • tags (list[str]) – A set of tags. Resource tags.

  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

class azure.mgmt.labservices.models.LabPlanUpdateProperties(*, default_connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, default_auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, default_network_profile: Optional[azure.mgmt.labservices.models._models_py3.LabPlanNetworkProfile] = None, allowed_regions: Optional[List[str]] = None, shared_gallery_id: Optional[str] = None, support_info: Optional[azure.mgmt.labservices.models._models_py3.SupportInfo] = None, linked_lms_instance: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Lab plan resource properties for updates.

Variables
  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

Keyword Arguments
  • default_connection_profile (ConnectionProfile) – The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

  • default_auto_shutdown_profile (AutoShutdownProfile) – The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

  • default_network_profile (LabPlanNetworkProfile) – 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.

  • allowed_regions (list[str]) – The allowed regions for the lab creator to use when creating labs using this lab plan.

  • shared_gallery_id (str) – 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.

  • support_info (SupportInfo) – 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.

  • linked_lms_instance (str) – Base Url of the lms instance this lab plan can link lab rosters against.

class azure.mgmt.labservices.models.LabProperties(*, auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, virtual_machine_profile: Optional[azure.mgmt.labservices.models._models_py3.VirtualMachineProfile] = None, security_profile: Optional[azure.mgmt.labservices.models._models_py3.SecurityProfile] = None, roster_profile: Optional[azure.mgmt.labservices.models._models_py3.RosterProfile] = None, lab_plan_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, network_profile: Optional[azure.mgmt.labservices.models._models_py3.LabNetworkProfile] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.LabUpdateProperties

Properties of a lab resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the lab. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • network_profile (LabNetworkProfile) – The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.

  • state (str or LabState) – The lab state. Possible values include: “Draft”, “Publishing”, “Scaling”, “Syncing”, “Published”.

Keyword Arguments
  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

  • network_profile (LabNetworkProfile) – The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.

class azure.mgmt.labservices.models.LabServicesSku(*, capacity: Optional[azure.mgmt.labservices.models._models_py3.LabServicesSkuCapacity] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Azure Lab Services resource SKUs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

capacity (LabServicesSkuCapacity) – The scale out/in options of the SKU.

class azure.mgmt.labservices.models.LabServicesSkuCapabilities(**kwargs)[source]

Bases: msrest.serialization.Model

The array of capabilities of a lab services SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • name (str) – The name of the capability for a SKU.

  • value (str) – The value of the capability for a SKU.

class azure.mgmt.labservices.models.LabServicesSkuCapacity(**kwargs)[source]

Bases: msrest.serialization.Model

The scale out/in options of the SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • default (long) – The default capacity for this resource.

  • minimum (long) – The lowest permitted capacity for this resource.

  • maximum (long) – The highest permitted capacity for this resource.

  • scale_type (str or ScaleType) – The localized name of the resource. Possible values include: “None”, “Manual”, “Automatic”.

class azure.mgmt.labservices.models.LabServicesSkuCost(**kwargs)[source]

Bases: msrest.serialization.Model

The array of costs of a lab services SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • meter_id (str) – The meter id.

  • quantity (float) – The quantity of units charged.

  • extended_unit (str) – The extended unit.

class azure.mgmt.labservices.models.LabServicesSkuRestrictions(**kwargs)[source]

Bases: msrest.serialization.Model

The restriction details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • type (str or RestrictionType) – The type of restriction. Possible values include: “Location”.

  • values (list[str]) – The values of the restriction.

  • reason_code (str or RestrictionReasonCode) – The reason for the restriction. Possible values include: “QuotaId”, “NotAvailableForSubscription”.

class azure.mgmt.labservices.models.LabServicesSkuTier(value)[source]

Bases: str, enum.Enum

The tier of the SKU.

PREMIUM = 'Premium'
STANDARD = 'Standard'
class azure.mgmt.labservices.models.LabState(value)[source]

Bases: str, enum.Enum

The state of a virtual machine.

DRAFT = 'Draft'

The lab is currently in draft (has not been published).

PUBLISHED = 'Published'

The lab has been published.

PUBLISHING = 'Publishing'

The lab is publishing.

SCALING = 'Scaling'

The lab is scaling.

SYNCING = 'Syncing'

The lab is syncing users.

class azure.mgmt.labservices.models.LabUpdate(*, tags: Optional[List[str]] = None, auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, virtual_machine_profile: Optional[azure.mgmt.labservices.models._models_py3.VirtualMachineProfile] = None, security_profile: Optional[azure.mgmt.labservices.models._models_py3.SecurityProfile] = None, roster_profile: Optional[azure.mgmt.labservices.models._models_py3.RosterProfile] = None, lab_plan_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.TrackedResourceUpdate

The lab resource for updates.

Variables
  • tags (list[str]) – A set of tags. Resource tags.

  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

Keyword Arguments
  • tags (list[str]) – A set of tags. Resource tags.

  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

class azure.mgmt.labservices.models.LabUpdateProperties(*, auto_shutdown_profile: Optional[azure.mgmt.labservices.models._models_py3.AutoShutdownProfile] = None, connection_profile: Optional[azure.mgmt.labservices.models._models_py3.ConnectionProfile] = None, virtual_machine_profile: Optional[azure.mgmt.labservices.models._models_py3.VirtualMachineProfile] = None, security_profile: Optional[azure.mgmt.labservices.models._models_py3.SecurityProfile] = None, roster_profile: Optional[azure.mgmt.labservices.models._models_py3.RosterProfile] = None, lab_plan_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of a lab resource used for updates.

Variables
  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

Keyword Arguments
  • auto_shutdown_profile (AutoShutdownProfile) – The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

  • connection_profile (ConnectionProfile) – The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

  • virtual_machine_profile (VirtualMachineProfile) – The profile used for creating lab virtual machines.

  • security_profile (SecurityProfile) – The lab security profile.

  • roster_profile (RosterProfile) – The lab user list management profile.

  • lab_plan_id (str) – 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..

  • title (str) – The title of the lab.

  • description (str) – The description of the lab.

class azure.mgmt.labservices.models.ListUsagesResult(**kwargs)[source]

Bases: msrest.serialization.Model

List of Core Usages.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[Usage]) – The array page of Usages.

  • next_link (str) – The link to get the next page of Usage result.

class azure.mgmt.labservices.models.Operation(*, display: Optional[azure.mgmt.labservices.models._models_py3.OperationDisplay] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

  • is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.

  • display (OperationDisplay) – Localized display information for this particular operation.

  • origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Possible values include: “user”, “system”, “user,system”.

  • action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. Possible values include: “Internal”.

Keyword Arguments

display (OperationDisplay) – Localized display information for this particular operation.

class azure.mgmt.labservices.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.Model

Localized display information for this particular operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

  • resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

  • operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

  • description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

class azure.mgmt.labservices.models.OperationListResult(**kwargs)[source]

Bases: msrest.serialization.Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[Operation]) – List of operations supported by the resource provider.

  • next_link (str) – URL to get the next set of operation list results (if there are any).

class azure.mgmt.labservices.models.OperationResult(*, status: Union[str, azure.mgmt.labservices.models._lab_services_client_enums.OperationStatus], start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, percent_complete: Optional[float] = None, error: Optional[azure.mgmt.labservices.models._models_py3.ErrorDetail] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A long running operation result.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • status (str or OperationStatus) – Required. The operation status. Possible values include: “NotStarted”, “InProgress”, “Succeeded”, “Failed”, “Canceled”.

  • start_time (datetime) – Start time.

  • end_time (datetime) – End time.

  • percent_complete (float) – Percent completion.

  • error (ErrorDetail) – The error for a failure if the operation failed.

Keyword Arguments
  • status (str or OperationStatus) – Required. The operation status. Possible values include: “NotStarted”, “InProgress”, “Succeeded”, “Failed”, “Canceled”.

  • start_time (datetime) – Start time.

  • end_time (datetime) – End time.

  • percent_complete (float) – Percent completion.

  • error (ErrorDetail) – The error for a failure if the operation failed.

class azure.mgmt.labservices.models.OperationStatus(value)[source]

Bases: str, enum.Enum

The operation status

CANCELED = 'Canceled'

Not supported yet.

FAILED = 'Failed'

The operation failed.

IN_PROGRESS = 'InProgress'

The operation is running.

NOT_STARTED = 'NotStarted'

The operation has been accepted but hasn’t started.

SUCCEEDED = 'Succeeded'

The operation Succeeded.

class azure.mgmt.labservices.models.Origin(value)[source]

Bases: str, enum.Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”

SYSTEM = 'system'
USER = 'user'
USER_SYSTEM = 'user,system'
class azure.mgmt.labservices.models.OsState(value)[source]

Bases: str, enum.Enum

The operating system state.

GENERALIZED = 'Generalized'

Image does not contain any machine and user specific information.

SPECIALIZED = 'Specialized'

Image contains machine and user specific information.

class azure.mgmt.labservices.models.OsType(value)[source]

Bases: str, enum.Enum

The operating system type.

LINUX = 'Linux'
WINDOWS = 'Windows'
class azure.mgmt.labservices.models.PagedImages(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of Lab services virtual machine images.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[Image]) – The array page of virtual machine images.

  • next_link (str) – The link to get the next page of image results.

class azure.mgmt.labservices.models.PagedLabPlans(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of lab plans.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[LabPlan]) – The array page of lab plans.

  • next_link (str) – The link to get the next page of lab plan results.

class azure.mgmt.labservices.models.PagedLabServicesSkus(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of lab services skus.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[LabServicesSku]) – The array page of sku results.

  • next_link (str) – The link to get the next page of sku results.

class azure.mgmt.labservices.models.PagedLabs(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of labs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[Lab]) – The array page of lab results.

  • next_link (str) – The link to get the next page of image results.

class azure.mgmt.labservices.models.PagedSchedules(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of schedules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[Schedule]) – The array page of schedule results.

  • next_link (str) – The link to get the next page of schedule results.

class azure.mgmt.labservices.models.PagedUsers(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of users.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[User]) – The array page of user results.

  • next_link (str) – The link to get the next page of image results.

class azure.mgmt.labservices.models.PagedVirtualMachines(**kwargs)[source]

Bases: msrest.serialization.Model

Paged list of lab services virtual machines.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[VirtualMachine]) – The array page of virtual machine results.

  • next_link (str) – The link to get the next page of virtual machine results.

class azure.mgmt.labservices.models.ProvisioningState(value)[source]

Bases: str, enum.Enum

Resource provisioning state.

CREATING = 'Creating'

Resource is in the process of being created.

DELETING = 'Deleting'

Resource is in the process of being deleted.

FAILED = 'Failed'

Previous operation on the resource has failed leaving resource in unhealthy state.

LOCKED = '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.

SUCCEEDED = 'Succeeded'

Resource is in healthy state after creation or update operation.

UPDATING = 'Updating'

New property values are being applied to the resource.

class azure.mgmt.labservices.models.ProxyResource(**kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.labservices.models.RecurrenceFrequency(value)[source]

Bases: str, enum.Enum

Schedule recurrence frequencies.

DAILY = 'Daily'

Schedule will run every days.

WEEKLY = 'Weekly'

Schedule will run every week on days specified in weekDays.

class azure.mgmt.labservices.models.RecurrencePattern(*, frequency: Union[str, azure.mgmt.labservices.models._lab_services_client_enums.RecurrenceFrequency], expiration_date: datetime.date, week_days: Optional[List[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.WeekDay]]] = None, interval: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Recurrence pattern of a lab schedule.

All required parameters must be populated in order to send to Azure.

Variables
  • frequency (str or RecurrenceFrequency) – Required. The frequency of the recurrence. Possible values include: “Daily”, “Weekly”.

  • week_days (list[str or WeekDay]) – The week days the schedule runs. Used for when the Frequency is set to Weekly.

  • interval (int) – 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.

  • expiration_date (date) – Required. When the recurrence will expire. This date is inclusive.

Keyword Arguments
  • frequency (str or RecurrenceFrequency) – Required. The frequency of the recurrence. Possible values include: “Daily”, “Weekly”.

  • week_days (list[str or WeekDay]) – The week days the schedule runs. Used for when the Frequency is set to Weekly.

  • interval (int) – 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.

  • expiration_date (date) – Required. When the recurrence will expire. This date is inclusive.

class azure.mgmt.labservices.models.RegistrationState(value)[source]

Bases: str, enum.Enum

The user lab registration state.

NOT_REGISTERED = 'NotRegistered'

User has registered with the lab.

REGISTERED = 'Registered'

User has not yet registered with the lab.

class azure.mgmt.labservices.models.ResetPasswordBody(*, username: str, password: str, **kwargs)[source]

Bases: msrest.serialization.Model

Body of a reset password request.

All required parameters must be populated in order to send to Azure.

Variables
  • username (str) – Required. The user whose password is being reset.

  • password (str) – Required. The password.

Keyword Arguments
  • username (str) – Required. The user whose password is being reset.

  • password (str) – Required. The password.

class azure.mgmt.labservices.models.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.labservices.models.RestrictionReasonCode(value)[source]

Bases: str, enum.Enum

The reason for the restriction.

NOT_AVAILABLE_FOR_SUBSCRIPTION = 'NotAvailableForSubscription'
QUOTA_ID = 'QuotaId'
class azure.mgmt.labservices.models.RestrictionType(value)[source]

Bases: str, enum.Enum

The type of restriction.

LOCATION = 'Location'
class azure.mgmt.labservices.models.RosterProfile(*, active_directory_group_id: Optional[str] = None, lti_context_id: Optional[str] = None, lms_instance: Optional[str] = None, lti_client_id: Optional[str] = None, lti_roster_endpoint: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The lab user list management profile.

Variables
  • active_directory_group_id (str) – The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.

  • lti_context_id (str) – The unique context identifier for the lab in the lms.

  • lms_instance (str) – The base URI identifying the lms instance.

  • lti_client_id (str) – The unique id of the azure lab services tool in the lms.

  • lti_roster_endpoint (str) – The uri of the names and roles service endpoint on the lms for the class attached to this lab.

Keyword Arguments
  • active_directory_group_id (str) – The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.

  • lti_context_id (str) – The unique context identifier for the lab in the lms.

  • lms_instance (str) – The base URI identifying the lms instance.

  • lti_client_id (str) – The unique id of the azure lab services tool in the lms.

  • lti_roster_endpoint (str) – The uri of the names and roles service endpoint on the lms for the class attached to this lab.

class azure.mgmt.labservices.models.SaveImageBody(*, name: Optional[str] = None, lab_virtual_machine_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Body for the save image POST.

Variables
  • name (str) – The name for the image we create.

  • lab_virtual_machine_id (str) – The ID of the lab virtual machine you want to save an image from.

Keyword Arguments
  • name (str) – The name for the image we create.

  • lab_virtual_machine_id (str) – The ID of the lab virtual machine you want to save an image from.

class azure.mgmt.labservices.models.ScaleType(value)[source]

Bases: str, enum.Enum

The localized name of the resource.

AUTOMATIC = 'Automatic'

The user is permitted to scale this SKU in and out.

MANUAL = 'Manual'

The user must manually scale this SKU in and out.

NONE = 'None'

The capacity is not adjustable in any way.

class azure.mgmt.labservices.models.Schedule(*, start_at: Optional[datetime.datetime] = None, stop_at: Optional[datetime.datetime] = None, recurrence_pattern: Optional[azure.mgmt.labservices.models._models_py3.RecurrencePattern] = None, time_zone_id: Optional[str] = None, notes: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.ProxyResource

Schedule for automatically turning virtual machines in a lab on and off at specified times.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the schedule.

  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the schedule. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

Keyword Arguments
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

class azure.mgmt.labservices.models.ScheduleProperties(*, start_at: Optional[datetime.datetime] = None, stop_at: Optional[datetime.datetime] = None, recurrence_pattern: Optional[azure.mgmt.labservices.models._models_py3.RecurrencePattern] = None, time_zone_id: Optional[str] = None, notes: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.ScheduleUpdateProperties

Schedule resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the schedule. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

Keyword Arguments
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

class azure.mgmt.labservices.models.ScheduleUpdate(*, start_at: Optional[datetime.datetime] = None, stop_at: Optional[datetime.datetime] = None, recurrence_pattern: Optional[azure.mgmt.labservices.models._models_py3.RecurrencePattern] = None, time_zone_id: Optional[str] = None, notes: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schedule for automatically turning virtual machines in a lab on and off at specified times. Used for updates.

Variables
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

Keyword Arguments
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

class azure.mgmt.labservices.models.ScheduleUpdateProperties(*, start_at: Optional[datetime.datetime] = None, stop_at: Optional[datetime.datetime] = None, recurrence_pattern: Optional[azure.mgmt.labservices.models._models_py3.RecurrencePattern] = None, time_zone_id: Optional[str] = None, notes: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schedule resource properties used for updates.

Variables
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

Keyword Arguments
  • start_at (datetime) – When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

  • stop_at (datetime) – When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

  • recurrence_pattern (RecurrencePattern) – The recurrence pattern of the scheduled actions.

  • time_zone_id (str) – The IANA timezone id for the schedule.

  • notes (str) – Notes for this schedule.

class azure.mgmt.labservices.models.SecurityProfile(*, open_access: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The lab security profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • registration_code (str) – The registration code for the lab.

  • open_access (str or EnableState) – Whether any user or only specified users can register to a lab. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

open_access (str or EnableState) – Whether any user or only specified users can register to a lab. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.labservices.models.ShutdownOnIdleMode(value)[source]

Bases: str, enum.Enum

Defines whether to shut down VM on idle and the criteria for idle detection.

LOW_USAGE = 'LowUsage'

The VM will be considered as idle when user is absent and the resource (CPU and disk) consumption is low.

NONE = 'None'

The VM won’t be shut down when it is idle.

USER_ABSENCE = 'UserAbsence'

The VM will be considered as idle when there is no keyboard or mouse input.

class azure.mgmt.labservices.models.Sku(*, name: str, tier: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.SkuTier]] = None, size: Optional[str] = None, family: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The resource model definition representing SKU.

All required parameters must be populated in order to send to Azure.

Variables
  • name (str) – Required. The name of the SKU. Ex - P3. It is typically a letter+number code.

  • tier (str or SkuTier) – 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. Possible values include: “Free”, “Basic”, “Standard”, “Premium”.

  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

  • capacity (int) – 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.

Keyword Arguments
  • name (str) – Required. The name of the SKU. Ex - P3. It is typically a letter+number code.

  • tier (str or SkuTier) – 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. Possible values include: “Free”, “Basic”, “Standard”, “Premium”.

  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

  • capacity (int) – 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.

class azure.mgmt.labservices.models.SkuTier(value)[source]

Bases: str, enum.Enum

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.

BASIC = 'Basic'
FREE = 'Free'
PREMIUM = 'Premium'
STANDARD = 'Standard'
class azure.mgmt.labservices.models.SupportInfo(*, url: Optional[str] = None, email: Optional[str] = None, phone: Optional[str] = None, instructions: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Support contact information and instructions.

Variables
  • url (str) – Support web address.

  • email (str) – Support contact email address.

  • phone (str) – Support contact phone number.

  • instructions (str) – Support instructions.

Keyword Arguments
  • url (str) – Support web address.

  • email (str) – Support contact email address.

  • phone (str) – Support contact phone number.

  • instructions (str) – Support instructions.

class azure.mgmt.labservices.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables
  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments
  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.labservices.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

Keyword Arguments
  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

class azure.mgmt.labservices.models.TrackedResourceUpdate(*, tags: Optional[List[str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Base tracked resource type for all PATCH updates.

Variables

tags (list[str]) – A set of tags. Resource tags.

Keyword Arguments

tags (list[str]) – A set of tags. Resource tags.

class azure.mgmt.labservices.models.Usage(*, current_value: Optional[int] = None, limit: Optional[int] = None, unit: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.UsageUnit]] = None, name: Optional[azure.mgmt.labservices.models._models_py3.UsageName] = None, id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The core usage details.

Variables
  • current_value (long) – The current usage.

  • limit (long) – The limit integer.

  • unit (str or UsageUnit) – The unit details. Possible values include: “Count”.

  • name (UsageName) – The name.

  • id (str) – The fully qualified arm resource id.

Keyword Arguments
  • current_value (long) – The current usage.

  • limit (long) – The limit integer.

  • unit (str or UsageUnit) – The unit details. Possible values include: “Count”.

  • name (UsageName) – The name.

  • id (str) – The fully qualified arm resource id.

class azure.mgmt.labservices.models.UsageName(*, localized_value: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Usage Names.

Variables
  • localized_value (str) – The localized name of the resource.

  • value (str) – The name of the resource.

Keyword Arguments
  • localized_value (str) – The localized name of the resource.

  • value (str) – The name of the resource.

class azure.mgmt.labservices.models.UsageUnit(value)[source]

Bases: str, enum.Enum

The unit details.

COUNT = 'Count'
class azure.mgmt.labservices.models.User(*, email: str, additional_usage_quota: Optional[datetime.timedelta] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.ProxyResource

User of a lab that can register for and use virtual machines within the lab.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the user resource.

  • additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the user resource. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • display_name (str) – Display name of the user, for example user’s full name.

  • email (str) – Required. Email address of the user.

  • registration_state (str or RegistrationState) – State of the user’s registration within the lab. Possible values include: “Registered”, “NotRegistered”.

  • invitation_state (str or InvitationState) – State of the invitation message for the user. Possible values include: “NotSent”, “Sending”, “Sent”, “Failed”.

  • invitation_sent (datetime) – Date and time when the invitation message was sent to the user.

  • total_usage (timedelta) – How long the user has used their virtual machines in this lab.

Keyword Arguments
  • additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

  • email (str) – Required. Email address of the user.

class azure.mgmt.labservices.models.UserProperties(*, email: str, additional_usage_quota: Optional[datetime.timedelta] = None, **kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.UserUpdateProperties

User resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the user resource. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • display_name (str) – Display name of the user, for example user’s full name.

  • email (str) – Required. Email address of the user.

  • registration_state (str or RegistrationState) – State of the user’s registration within the lab. Possible values include: “Registered”, “NotRegistered”.

  • invitation_state (str or InvitationState) – State of the invitation message for the user. Possible values include: “NotSent”, “Sending”, “Sent”, “Failed”.

  • invitation_sent (datetime) – Date and time when the invitation message was sent to the user.

  • total_usage (timedelta) – How long the user has used their virtual machines in this lab.

Keyword Arguments
  • additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

  • email (str) – Required. Email address of the user.

class azure.mgmt.labservices.models.UserUpdate(*, additional_usage_quota: Optional[datetime.timedelta] = None, **kwargs)[source]

Bases: msrest.serialization.Model

User of a lab that can register for and use virtual machines within the lab. Used for updates.

Variables

additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

Keyword Arguments

additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

class azure.mgmt.labservices.models.UserUpdateProperties(*, additional_usage_quota: Optional[datetime.timedelta] = None, **kwargs)[source]

Bases: msrest.serialization.Model

User resource properties used for updates.

Variables

additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

Keyword Arguments

additional_usage_quota (timedelta) – The amount of usage quota time the user gets in addition to the lab usage quota.

class azure.mgmt.labservices.models.VirtualMachine(**kwargs)[source]

Bases: azure.mgmt.labservices.models._models_py3.ProxyResource

A lab virtual machine resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – System data of the Lab virtual machine.

  • provisioning_state (str or ProvisioningState) – Current provisioning state of the virtual machine. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Locked”.

  • state (str or VirtualMachineState) – The current state of the virtual machine. Possible values include: “Stopped”, “Starting”, “Running”, “Stopping”, “ResettingPassword”, “Reimaging”, “Redeploying”.

  • connection_profile (VirtualMachineConnectionProfile) – Profile for information about connecting to the virtual machine.

  • claimed_by_user_id (str) – The lab user ID (not the PUID!) of who claimed the virtual machine.

  • vm_type (str or VirtualMachineType) – The type of this VM resource. Possible values include: “User”, “Template”.

class azure.mgmt.labservices.models.VirtualMachineAdditionalCapabilities(*, install_gpu_drivers: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The additional capabilities for a lab VM.

Variables

install_gpu_drivers (str or EnableState) – Flag to pre-install dedicated GPU drivers. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

install_gpu_drivers (str or EnableState) – Flag to pre-install dedicated GPU drivers. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.labservices.models.VirtualMachineConnectionProfile(**kwargs)[source]

Bases: msrest.serialization.Model

The connection information for the virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • private_ip_address (str) – The private IP address of the virtual machine.

  • ssh_authority (str) – Port and host name separated by semicolon for connecting via SSH protocol to the virtual machine.

  • ssh_in_browser_url (str) – URL for connecting via SSH protocol to the virtual machine in browser.

  • rdp_authority (str) – Port and host name separated by semicolon for connecting via RDP protocol to the virtual machine.

  • rdp_in_browser_url (str) – URL for connecting via RDP protocol to the virtual machine in browser.

  • admin_username (str) – The username used to log on to the virtual machine as admin.

  • non_admin_username (str) – The username used to log on to the virtual machine as non-admin, if one exists.

class azure.mgmt.labservices.models.VirtualMachineProfile(*, create_option: Union[str, azure.mgmt.labservices.models._lab_services_client_enums.CreateOption], image_reference: azure.mgmt.labservices.models._models_py3.ImageReference, sku: azure.mgmt.labservices.models._models_py3.Sku, usage_quota: datetime.timedelta, admin_user: azure.mgmt.labservices.models._models_py3.Credentials, additional_capabilities: Optional[azure.mgmt.labservices.models._models_py3.VirtualMachineAdditionalCapabilities] = None, use_shared_password: Optional[Union[str, azure.mgmt.labservices.models._lab_services_client_enums.EnableState]] = None, non_admin_user: Optional[azure.mgmt.labservices.models._models_py3.Credentials] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The base virtual machine configuration for a lab.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • create_option (str or CreateOption) – Required. Indicates what lab virtual machines are created from. Possible values include: “Image”, “TemplateVM”.

  • image_reference (ImageReference) – Required. The image configuration for lab virtual machines.

  • os_type (str or OsType) – The OS type of the image. Possible values include: “Windows”, “Linux”.

  • sku (Sku) – Required. The SKU for the lab. Defines the type of virtual machines used in the lab.

  • additional_capabilities (VirtualMachineAdditionalCapabilities) – Additional VM capabilities.

  • usage_quota (timedelta) – Required. The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours.

  • use_shared_password (str or EnableState) – Enabling this option will use the same password for all user VMs. Possible values include: “Enabled”, “Disabled”.

  • admin_user (Credentials) – Required. Credentials for the admin user on the VM.

  • non_admin_user (Credentials) – Credentials for the non-admin user on the VM, if one exists.

Keyword Arguments
  • create_option (str or CreateOption) – Required. Indicates what lab virtual machines are created from. Possible values include: “Image”, “TemplateVM”.

  • image_reference (ImageReference) – Required. The image configuration for lab virtual machines.

  • sku (Sku) – Required. The SKU for the lab. Defines the type of virtual machines used in the lab.

  • additional_capabilities (VirtualMachineAdditionalCapabilities) – Additional VM capabilities.

  • usage_quota (timedelta) – Required. The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours.

  • use_shared_password (str or EnableState) – Enabling this option will use the same password for all user VMs. Possible values include: “Enabled”, “Disabled”.

  • admin_user (Credentials) – Required. Credentials for the admin user on the VM.

  • non_admin_user (Credentials) – Credentials for the non-admin user on the VM, if one exists.

class azure.mgmt.labservices.models.VirtualMachineState(value)[source]

Bases: str, enum.Enum

The state of a virtual machine.

REDEPLOYING = 'Redeploying'

The VM is being redeployed.

REIMAGING = 'Reimaging'

The VM is being reimaged.

RESETTING_PASSWORD = 'ResettingPassword'

The VM password is being reset.

RUNNING = 'Running'

The VM is running.

STARTING = 'Starting'

The VM is starting.

STOPPED = 'Stopped'

The VM is currently stopped.

STOPPING = 'Stopping'

The VM is stopping.

class azure.mgmt.labservices.models.VirtualMachineType(value)[source]

Bases: str, enum.Enum

The type of the lab virtual machine.

TEMPLATE = 'Template'

A template VM.

USER = 'User'

A user VM.

class azure.mgmt.labservices.models.WeekDay(value)[source]

Bases: str, enum.Enum

Days of the week.

FRIDAY = 'Friday'

Schedule will run on Friday.

MONDAY = 'Monday'

Schedule will run on Monday.

SATURDAY = 'Saturday'

Schedule will run on Saturday.

SUNDAY = 'Sunday'

Schedule will run on Sunday.

THURSDAY = 'Thursday'

Schedule will run on Thursday.

TUESDAY = 'Tuesday'

Schedule will run on Tuesday.

WEDNESDAY = 'Wednesday'

Schedule will run on Wednesday.