azure.mgmt.labservices.models module¶
-
class
azure.mgmt.labservices.models.
AddUsersPayload
(*, email_addresses, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Payload for Add Users operation on a Lab.
All required parameters must be populated in order to send to Azure.
Parameters: email_addresses (list[str]) – Required. List of user emails addresses to add to the lab.
-
class
azure.mgmt.labservices.models.
ReferenceVmCreationParameters
(*, user_name: str, password: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Creation parameters for Reference Vm.
All required parameters must be populated in order to send to Azure.
Parameters:
-
class
azure.mgmt.labservices.models.
ResourceSettingCreationParameters
(*, gallery_image_resource_id: str, reference_vm_creation_parameters, location: str = None, name: str = None, size=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents resource specific settings.
All required parameters must be populated in order to send to Azure.
Parameters: - location (str) – The location where the virtual machine will live
- name (str) – The name of the resource setting
- gallery_image_resource_id (str) – Required. The resource id of the gallery image used for creating the virtual machine
- size (str or ManagedLabVmSize) – The size of the virtual machine. Possible values include: ‘Basic’, ‘Standard’, ‘Performance’
- reference_vm_creation_parameters (ReferenceVmCreationParameters) – Required. Creation parameters for Reference Vm
-
class
azure.mgmt.labservices.models.
EnvironmentSettingCreationParameters
(*, resource_setting_creation_parameters, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Settings related to creating an environment setting.
All required parameters must be populated in order to send to Azure.
Parameters: resource_setting_creation_parameters (ResourceSettingCreationParameters) – Required. The resource specific settings
-
class
azure.mgmt.labservices.models.
LabCreationParameters
(*, max_users_in_lab: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Settings related to creating a lab.
Parameters: max_users_in_lab (int) – Maximum number of users allowed in the lab.
-
class
azure.mgmt.labservices.models.
CreateLabProperties
(*, lab_creation_parameters, name: str, environment_setting_creation_parameters=None, location: str = None, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties for creating a managed lab and a default environment setting.
All required parameters must be populated in order to send to Azure.
Parameters: - environment_setting_creation_parameters (EnvironmentSettingCreationParameters) – Settings related to creating an environment setting
- lab_creation_parameters (LabCreationParameters) – Required. Settings related to creating a lab
- name (str) – Required. The name of the resource
- location (str) – The location of the resource
- tags (dict[str, str]) – The tags of the resource.
-
class
azure.mgmt.labservices.models.
ResourceSet
(*, vm_resource_id: str = None, resource_setting_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents a VM and the setting Id it was created for.
Parameters:
-
class
azure.mgmt.labservices.models.
NetworkInterface
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Network details of the environment.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.labservices.models.
LatestOperationResult
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Details of the status of an operation.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - status (str) – The current status of the operation.
- error_code (str) – Error code on failure.
- error_message (str) – The error message.
- request_uri (str) – Request URI of the operation.
- http_method (str) – The HttpMethod - PUT/POST/DELETE for the operation.
- operation_url (str) – The URL to use to check long-running operation status
-
class
azure.mgmt.labservices.models.
Environment
(*, location: str = None, tags=None, resource_sets=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents an environment instance.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – The identifier of the resource.
- name (str) – The name of the resource.
- type (str) – The type of the resource.
- claimed_by_user_object_id (str) – The AAD object Id of the user who has claimed the environment
- claimed_by_user_principal_id (str) – The user principal Id of the user who has claimed the environment
- claimed_by_user_name (str) – The name or email address of the user who has claimed the environment
- is_claimed (bool) – Is the environment claimed or not
- last_known_power_state (str) – Last known power state of the environment
- network_interface (NetworkInterface) – Network details of the environment
- total_usage (timedelta) – How long the environment has been used by a lab user
- password_last_reset (datetime) – When the password was last reset on the environment.
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- resource_sets (ResourceSet) – The set of a VM and the setting id it was created for
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
VirtualMachineDetails
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Details of the backing virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - provisioning_state (str) – Provisioning state of the Dtl VM
- rdp_authority (str) – Connection information for Windows
- ssh_authority (str) – Connection information for Linux
- private_ip_address (str) – PrivateIp address of the compute VM
- user_name (str) – Compute VM login user name
- last_known_power_state (str) – Last known compute power state captured in DTL
-
class
azure.mgmt.labservices.models.
EnvironmentDetails
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
This represents the details about a User’s environment and its state.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - name (str) – Name of the Environment
- description (str) – Description of the Environment
- id (str) – Resource Id of the environment
- provisioning_state (str) – The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status.
- virtual_machine_details (VirtualMachineDetails) – Details of backing DTL virtual machine with compute and network details.
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
- environment_state (str) – Publishing state of the environment setting Possible values are Creating, Created, Failed
- total_usage (timedelta) – How long the environment has been used by a lab user
- password_last_reset (datetime) – When the password was last reset on the environment.
-
class
azure.mgmt.labservices.models.
ResourceSetFragment
(*, vm_resource_id: str = None, resource_setting_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents a VM and the setting Id it was created for.
Parameters:
-
class
azure.mgmt.labservices.models.
EnvironmentFragment
(*, location: str = None, tags=None, resource_sets=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents an environment instance.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- resource_sets (ResourceSetFragment) – The set of a VM and the setting id it was created for
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
EnvironmentOperationsPayload
(*, environment_id: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents payload for any Environment operations like get, start, stop, connect.
All required parameters must be populated in order to send to Azure.
Parameters: environment_id (str) – Required. The resourceId of the environment
-
class
azure.mgmt.labservices.models.
VmStateDetails
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Details about the state of the reference virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - rdp_authority (str) – The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- ssh_authority (str) – The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
- power_state (str) – The power state of the reference virtual machine.
- last_known_power_state (str) – Last known compute power state captured in DTL
-
class
azure.mgmt.labservices.models.
ReferenceVm
(*, user_name: str, password: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Details of a Reference Vm.
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.
Parameters: Variables: - vm_state_details (VmStateDetails) – The state details for the reference virtual machine.
- vm_resource_id (str) – VM resource Id for the environment
-
class
azure.mgmt.labservices.models.
ResourceSettings
(*, reference_vm, gallery_image_resource_id: str = None, size=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents resource specific settings.
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: Parameters: - gallery_image_resource_id (str) – The resource id of the gallery image used for creating the virtual machine
- size (str or ManagedLabVmSize) – The size of the virtual machine. Possible values include: ‘Basic’, ‘Standard’, ‘Performance’
- reference_vm (ReferenceVm) – Required. Details specific to Reference Vm
-
class
azure.mgmt.labservices.models.
EnvironmentSetting
(*, resource_settings, location: str = None, tags=None, configuration_state=None, description: str = None, title: str = None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents settings of an environment, from which environment instances would be created.
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) – The identifier of the resource.
- name (str) – The name of the resource.
- type (str) – The type of the resource.
- publishing_state (str or PublishingState) – Describes the readiness of this environment setting. Possible values include: ‘Draft’, ‘Publishing’, ‘Published’, ‘PublishFailed’, ‘Scaling’
- last_changed (datetime) – Time when the template VM was last changed.
- last_published (datetime) – Time when the template VM was last sent for publishing.
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- configuration_state (str or ConfigurationState) – Describes the user’s progress in configuring their environment setting. Possible values include: ‘NotApplicable’, ‘Completed’
- description (str) – Describes the environment and its resource settings
- title (str) – Brief title describing the environment and its resource settings
- resource_settings (ResourceSettings) – Required. The resource specific settings
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
ReferenceVmFragment
(*, user_name: str = None, password: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Details of a Reference Vm.
Parameters:
-
class
azure.mgmt.labservices.models.
ResourceSettingsFragment
(*, gallery_image_resource_id: str = None, size=None, reference_vm=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents resource specific settings.
Parameters: - gallery_image_resource_id (str) – The resource id of the gallery image used for creating the virtual machine
- size (str or ManagedLabVmSize) – The size of the virtual machine. Possible values include: ‘Basic’, ‘Standard’, ‘Performance’
- reference_vm (ReferenceVmFragment) – Details specific to Reference Vm
-
class
azure.mgmt.labservices.models.
EnvironmentSettingFragment
(*, location: str = None, tags=None, configuration_state=None, description: str = None, title: str = None, resource_settings=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents settings of an environment, from which environment instances would be created.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- configuration_state (str or ConfigurationState) – Describes the user’s progress in configuring their environment setting. Possible values include: ‘NotApplicable’, ‘Completed’
- description (str) – Describes the environment and its resource settings
- title (str) – Brief title describing the environment and its resource settings
- resource_settings (ResourceSettingsFragment) – The resource specific settings
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
SizeInfo
(*, compute_size: str = None, price=None, number_of_cores: int = None, memory: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contains detailed information about a size.
Parameters: - compute_size (str) – Represents the actual compute size, e.g. Standard_A2_v2.
- price (decimal.Decimal) – The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost.
- number_of_cores (int) – The number of cores a VM of this size has.
- memory (float) – The amount of memory available (in GB).
-
class
azure.mgmt.labservices.models.
EnvironmentSize
(*, name=None, vm_sizes=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents a size category supported by this Lab Account (small, medium or large).
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: - name (str or ManagedLabVmSize) – The size category. Possible values include: ‘Basic’, ‘Standard’, ‘Performance’
- vm_sizes (list[SizeInfo]) – Represents a set of compute sizes that can serve this given size type
Variables: - max_price (decimal.Decimal) – The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier.
- min_number_of_cores (int) – The number of cores a VM of this size has. This is the minimum number of cores within this tier.
- min_memory (float) – The amount of memory available (in GB). This is the minimum amount of memory within this tier.
-
class
azure.mgmt.labservices.models.
SizeInfoFragment
(*, compute_size: str = None, price=None, number_of_cores: int = None, memory: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contains detailed information about a size.
Parameters: - compute_size (str) – Represents the actual compute size, e.g. Standard_A2_v2.
- price (decimal.Decimal) – The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost.
- number_of_cores (int) – The number of cores a VM of this size has.
- memory (float) – The amount of memory available (in GB).
-
class
azure.mgmt.labservices.models.
EnvironmentSizeFragment
(*, name=None, vm_sizes=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents a size category supported by this Lab Account (small, medium or large).
Parameters: - name (str or ManagedLabVmSize) – The size category. Possible values include: ‘Basic’, ‘Standard’, ‘Performance’
- vm_sizes (list[SizeInfoFragment]) – Represents a set of compute sizes that can serve this given size type
-
class
azure.mgmt.labservices.models.
GalleryImageReference
(*, offer: str = None, publisher: str = None, sku: str = None, os_type: str = None, version: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The reference information for an Azure Marketplace image.
Parameters:
-
class
azure.mgmt.labservices.models.
GalleryImage
(*, location: str = None, tags=None, is_enabled: bool = None, is_override: bool = None, is_plan_authorized: bool = None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents an image from the Azure Marketplace.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – The identifier of the resource.
- name (str) – The name of the resource.
- type (str) – The type of the resource.
- author (str) – The author of the gallery image.
- created_date (datetime) – The creation date of the gallery image.
- description (str) – The description of the gallery image.
- image_reference (GalleryImageReference) – The image reference of the gallery image.
- icon (str) – The icon of the gallery image.
- plan_id (str) – The third party plan that applies to this image
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- is_enabled (bool) – Indicates whether this gallery image is enabled.
- is_override (bool) – Indicates whether this gallery has been overridden for this lab account
- is_plan_authorized (bool) – Indicates if the plan has been authorized for programmatic deployment.
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
GalleryImageFragment
(*, location: str = None, tags=None, is_enabled: bool = None, is_override: bool = None, is_plan_authorized: bool = None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents an image from the Azure Marketplace.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- is_enabled (bool) – Indicates whether this gallery image is enabled.
- is_override (bool) – Indicates whether this gallery has been overridden for this lab account
- is_plan_authorized (bool) – Indicates if the plan has been authorized for programmatic deployment.
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
GalleryImageReferenceFragment
(*, offer: str = None, publisher: str = None, sku: str = None, os_type: str = None, version: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The reference information for an Azure Marketplace image.
Parameters:
-
class
azure.mgmt.labservices.models.
GetEnvironmentResponse
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the environments details.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: environment (EnvironmentDetails) – Details of the environment
-
class
azure.mgmt.labservices.models.
GetPersonalPreferencesResponse
(*, id: str = None, favorite_lab_resource_ids=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the PersonalPreferences for the user.
Parameters:
-
class
azure.mgmt.labservices.models.
SizeAvailability
(*, size_category=None, is_available: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the size information.
Parameters: - size_category (str or ManagedLabVmSize) – The category of the size (Basic, Standard, Performance). Possible values include: ‘Basic’, ‘Standard’, ‘Performance’
- is_available (bool) – Whether or not this size category is available
-
class
azure.mgmt.labservices.models.
RegionalAvailability
(*, region: str = None, size_availabilities=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The availability information of sizes across regions.
Parameters: - region (str) – Corresponding region
- size_availabilities (list[SizeAvailability]) – List of all the size information for the region
-
class
azure.mgmt.labservices.models.
GetRegionalAvailabilityResponse
(*, regional_availability=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The response model from the GetRegionalAvailability action.
Parameters: regional_availability (list[RegionalAvailability]) – Availability information for different size categories per region
-
class
azure.mgmt.labservices.models.
Lab
(*, location: str = None, tags=None, max_users_in_lab: int = None, usage_quota=None, user_access_mode=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents a lab.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – The identifier of the resource.
- name (str) – The name of the resource.
- type (str) – The type of the resource.
- user_quota (int) – Maximum value MaxUsersInLab can be set to, as specified by the service
- invitation_code (str) – Invitation code that users can use to join a lab.
- created_by_object_id (str) – Object id of the user that created the lab.
- created_by_user_principal_name (str) – Lab creator name
- created_date (datetime) – Creation date for the lab
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- max_users_in_lab (int) – Maximum number of users allowed in the lab.
- usage_quota (timedelta) – Maximum duration a user can use an environment for in the lab.
- user_access_mode (str or LabUserAccessMode) – Lab user access mode (open to all vs. restricted to those listed on the lab). Possible values include: ‘Restricted’, ‘Open’
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
SizeConfigurationProperties
(*, environment_sizes=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the size configuration under the lab account.
Parameters: environment_sizes (list[EnvironmentSize]) – Represents a list of size categories supported by this Lab Account (Small, Medium, Large)
-
class
azure.mgmt.labservices.models.
LabAccount
(*, location: str = None, tags=None, enabled_region_selection: bool = None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents a lab account.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – The identifier of the resource.
- name (str) – The name of the resource.
- type (str) – The type of the resource.
- size_configuration (SizeConfigurationProperties) – Represents the size configuration under the lab account
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- enabled_region_selection (bool) – Represents if region selection is enabled
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
LabAccountFragment
(*, location: str = None, tags=None, enabled_region_selection: bool = None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents a lab account.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- enabled_region_selection (bool) – Represents if region selection is enabled
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
LabDetails
(*, name: str = None, provisioning_state: str = None, id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
This represents the details about a lab that the User is in, and its state.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: Variables: usage_quota (timedelta) – The maximum duration a user can use a VM in this lab.
-
class
azure.mgmt.labservices.models.
LabFragment
(*, location: str = None, tags=None, max_users_in_lab: int = None, usage_quota=None, user_access_mode=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
Represents a lab.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - location (str) – The location of the resource.
- tags (dict[str, str]) – The tags of the resource.
- max_users_in_lab (int) – Maximum number of users allowed in the lab.
- usage_quota (timedelta) – Maximum duration a user can use an environment for in the lab.
- user_access_mode (str or LabUserAccessMode) – Lab user access mode (open to all vs. restricted to those listed on the lab). Possible values include: ‘Restricted’, ‘Open’
- provisioning_state (str) – The provisioning status of the resource.
- unique_identifier (str) – The unique immutable identifier of a resource (Guid).
-
class
azure.mgmt.labservices.models.
ListEnvironmentsPayload
(*, lab_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the payload to list environments owned by a user.
Parameters: lab_id (str) – The resource Id of the lab
-
class
azure.mgmt.labservices.models.
ListEnvironmentsResponse
(*, environments=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the list of environments owned by a user.
Parameters: environments (list[EnvironmentDetails]) – List of all the environments
-
class
azure.mgmt.labservices.models.
ListLabsResponse
(*, labs=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Lists the labs owned by a user.
Parameters: labs (list[LabDetails]) – List of all the labs
-
class
azure.mgmt.labservices.models.
OperationBatchStatusPayload
(*, urls, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Payload to get the status of an operation.
All required parameters must be populated in order to send to Azure.
Parameters: urls (list[str]) – Required. The operation url of long running operation
-
class
azure.mgmt.labservices.models.
OperationBatchStatusResponseItem
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the status of an operation that used the batch API.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.labservices.models.
OperationBatchStatusResponse
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Status Details of the long running operation for an environment.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: items (list[OperationBatchStatusResponseItem]) – Gets a collection of items that contain the operation url and status.
-
class
azure.mgmt.labservices.models.
OperationError
(*, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error details for the operation in case of a failure.
Parameters:
-
class
azure.mgmt.labservices.models.
OperationMetadataDisplay
(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The object that describes the operations.
Parameters:
-
class
azure.mgmt.labservices.models.
OperationMetadata
(*, name: str = None, display=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The REST API operation supported by ManagedLab ResourceProvider.
Parameters: - name (str) – Operation name: {provider}/{resource}/{operation}
- display (OperationMetadataDisplay) – The object that describes the operations
-
class
azure.mgmt.labservices.models.
OperationResult
(*, status: str = None, error=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An Operation Result.
Parameters: - status (str) – The operation status.
- error (OperationError) – Error details for the operation in case of a failure.
-
class
azure.mgmt.labservices.models.
OperationStatusPayload
(*, operation_url: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Payload to get the status of an operation.
All required parameters must be populated in order to send to Azure.
Parameters: operation_url (str) – Required. The operation url of long running operation
-
class
azure.mgmt.labservices.models.
OperationStatusResponse
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Status Details of the long running operation for an environment.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: status (str) – status of the long running operation for an environment
-
class
azure.mgmt.labservices.models.
PersonalPreferencesOperationsPayload
(*, lab_account_resource_id: str = None, add_remove=None, lab_resource_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents payload for any Environment operations like get, start, stop, connect.
Parameters:
-
class
azure.mgmt.labservices.models.
PublishPayload
(*, use_existing_image: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Payload for Publish operation on EnvironmentSetting.
Parameters: use_existing_image (bool) – Whether to use existing VM custom image when publishing.
-
class
azure.mgmt.labservices.models.
RegisterPayload
(*, registration_code: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents payload for Register action.
Parameters: registration_code (str) – The registration code of the lab.
-
class
azure.mgmt.labservices.models.
ResetPasswordPayload
(*, environment_id: str, username: str = None, password: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the payload for resetting passwords.
All required parameters must be populated in order to send to Azure.
Parameters:
-
class
azure.mgmt.labservices.models.
Resource
(*, location: str = None, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An Azure resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.labservices.models.
SizeConfigurationPropertiesFragment
(*, environment_sizes=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the size configuration under the lab account.
Parameters: environment_sizes (list[EnvironmentSizeFragment]) – Represents a list of size categories supported by this Lab Account (Small, Medium, Large)
-
class
azure.mgmt.labservices.models.
User
(*, location: str = None, tags=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
The User registered to a lab.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – The identifier of the resource.
- name (str) – The name of the resource.
- type (str) – The type of the resource.
- email (str) – The user email address, as it was specified during registration.
- family_name (str) – The user family name, as it was specified during registration.
- given_name (str) – The user given name, as it was specified during registration.
- tenant_id (str) – The user tenant ID, as it was specified during registration.
- total_usage (timedelta) – How long the user has used his VMs in this lab
- latest_operation_result (LatestOperationResult) – The details of the latest operation. ex: status, error
Parameters:
-
class
azure.mgmt.labservices.models.
UserFragment
(*, location: str = None, tags=None, provisioning_state: str = None, unique_identifier: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.labservices.models.resource_py3.Resource
The User registered to a lab.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.labservices.models.
OperationMetadataPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
OperationMetadata
object
-
class
azure.mgmt.labservices.models.
LabAccountPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
LabAccount
object
-
class
azure.mgmt.labservices.models.
GalleryImagePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GalleryImage
object
-
class
azure.mgmt.labservices.models.
LabPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Lab
object
-
class
azure.mgmt.labservices.models.
EnvironmentSettingPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
EnvironmentSetting
object
-
class
azure.mgmt.labservices.models.
EnvironmentPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Environment
object
-
class
azure.mgmt.labservices.models.
UserPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
User
object
-
class
azure.mgmt.labservices.models.
ManagedLabVmSize
[source]¶ -
An enumeration.
-
basic
= 'Basic'¶ The base VM size
-
performance
= 'Performance'¶ The most performant VM size
-
standard
= 'Standard'¶ The standard or default VM size
-
-
class
azure.mgmt.labservices.models.
PublishingState
[source]¶ -
An enumeration.
-
draft
= 'Draft'¶ Initial state of an environment setting.
-
publish_failed
= 'PublishFailed'¶ Failed to provision all the necessary resources.
-
published
= 'Published'¶ All resources are currently provisioned.
-
publishing
= 'Publishing'¶ Currently provisioning resources.
-
scaling
= 'Scaling'¶ Currently provisioning resources without recreating VM image.
-
-
class
azure.mgmt.labservices.models.
ConfigurationState
[source]¶ -
An enumeration.
-
completed
= 'Completed'¶ User is finished modifying the template.
-
not_applicable
= 'NotApplicable'¶ User either hasn’t started configuring their template or they haven’t started the configuration process.
-