# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
from typing import Dict, List, Optional, Union
from azure.core.exceptions import HttpResponseError
import msrest.serialization
from ._lab_services_client_enums import *
[docs]class AutoShutdownProfile(msrest.serialization.Model):
"""Profile for how to handle shutting down virtual machines.
:ivar shutdown_on_disconnect: Whether shutdown on disconnect is enabled. Possible values
include: "Enabled", "Disabled".
:vartype shutdown_on_disconnect: str or ~azure.mgmt.labservices.models.EnableState
:ivar shutdown_when_not_connected: Whether a VM will get shutdown when it hasn't been connected
to after a period of time. Possible values include: "Enabled", "Disabled".
:vartype shutdown_when_not_connected: str or ~azure.mgmt.labservices.models.EnableState
:ivar shutdown_on_idle: Whether a VM will get shutdown when it has idled for a period of time.
Possible values include: "None", "UserAbsence", "LowUsage".
:vartype shutdown_on_idle: str or ~azure.mgmt.labservices.models.ShutdownOnIdleMode
:ivar disconnect_delay: The amount of time a VM will stay running after a user disconnects if
this behavior is enabled.
:vartype disconnect_delay: ~datetime.timedelta
:ivar no_connect_delay: The amount of time a VM will stay running before it is shutdown if no
connection is made and this behavior is enabled.
:vartype no_connect_delay: ~datetime.timedelta
:ivar idle_delay: The amount of time a VM will idle before it is shutdown if this behavior is
enabled.
:vartype idle_delay: ~datetime.timedelta
"""
_attribute_map = {
'shutdown_on_disconnect': {'key': 'shutdownOnDisconnect', 'type': 'str'},
'shutdown_when_not_connected': {'key': 'shutdownWhenNotConnected', 'type': 'str'},
'shutdown_on_idle': {'key': 'shutdownOnIdle', 'type': 'str'},
'disconnect_delay': {'key': 'disconnectDelay', 'type': 'duration'},
'no_connect_delay': {'key': 'noConnectDelay', 'type': 'duration'},
'idle_delay': {'key': 'idleDelay', 'type': 'duration'},
}
def __init__(
self,
*,
shutdown_on_disconnect: Optional[Union[str, "EnableState"]] = None,
shutdown_when_not_connected: Optional[Union[str, "EnableState"]] = None,
shutdown_on_idle: Optional[Union[str, "ShutdownOnIdleMode"]] = None,
disconnect_delay: Optional[datetime.timedelta] = None,
no_connect_delay: Optional[datetime.timedelta] = None,
idle_delay: Optional[datetime.timedelta] = None,
**kwargs
):
"""
:keyword shutdown_on_disconnect: Whether shutdown on disconnect is enabled. Possible values
include: "Enabled", "Disabled".
:paramtype shutdown_on_disconnect: str or ~azure.mgmt.labservices.models.EnableState
:keyword shutdown_when_not_connected: Whether a VM will get shutdown when it hasn't been
connected to after a period of time. Possible values include: "Enabled", "Disabled".
:paramtype shutdown_when_not_connected: str or ~azure.mgmt.labservices.models.EnableState
:keyword shutdown_on_idle: Whether a VM will get shutdown when it has idled for a period of
time. Possible values include: "None", "UserAbsence", "LowUsage".
:paramtype shutdown_on_idle: str or ~azure.mgmt.labservices.models.ShutdownOnIdleMode
:keyword disconnect_delay: The amount of time a VM will stay running after a user disconnects
if this behavior is enabled.
:paramtype disconnect_delay: ~datetime.timedelta
:keyword no_connect_delay: The amount of time a VM will stay running before it is shutdown if
no connection is made and this behavior is enabled.
:paramtype no_connect_delay: ~datetime.timedelta
:keyword idle_delay: The amount of time a VM will idle before it is shutdown if this behavior
is enabled.
:paramtype idle_delay: ~datetime.timedelta
"""
super(AutoShutdownProfile, self).__init__(**kwargs)
self.shutdown_on_disconnect = shutdown_on_disconnect
self.shutdown_when_not_connected = shutdown_when_not_connected
self.shutdown_on_idle = shutdown_on_idle
self.disconnect_delay = disconnect_delay
self.no_connect_delay = no_connect_delay
self.idle_delay = idle_delay
[docs]class ConnectionProfile(msrest.serialization.Model):
"""Connection profile for how users connect to lab virtual machines.
:ivar web_ssh_access: The enabled access level for Web Access over SSH. Possible values
include: "Public", "Private", "None".
:vartype web_ssh_access: str or ~azure.mgmt.labservices.models.ConnectionType
:ivar web_rdp_access: The enabled access level for Web Access over RDP. Possible values
include: "Public", "Private", "None".
:vartype web_rdp_access: str or ~azure.mgmt.labservices.models.ConnectionType
:ivar client_ssh_access: The enabled access level for Client Access over SSH. Possible values
include: "Public", "Private", "None".
:vartype client_ssh_access: str or ~azure.mgmt.labservices.models.ConnectionType
:ivar client_rdp_access: The enabled access level for Client Access over RDP. Possible values
include: "Public", "Private", "None".
:vartype client_rdp_access: str or ~azure.mgmt.labservices.models.ConnectionType
"""
_attribute_map = {
'web_ssh_access': {'key': 'webSshAccess', 'type': 'str'},
'web_rdp_access': {'key': 'webRdpAccess', 'type': 'str'},
'client_ssh_access': {'key': 'clientSshAccess', 'type': 'str'},
'client_rdp_access': {'key': 'clientRdpAccess', 'type': 'str'},
}
def __init__(
self,
*,
web_ssh_access: Optional[Union[str, "ConnectionType"]] = None,
web_rdp_access: Optional[Union[str, "ConnectionType"]] = None,
client_ssh_access: Optional[Union[str, "ConnectionType"]] = None,
client_rdp_access: Optional[Union[str, "ConnectionType"]] = None,
**kwargs
):
"""
:keyword web_ssh_access: The enabled access level for Web Access over SSH. Possible values
include: "Public", "Private", "None".
:paramtype web_ssh_access: str or ~azure.mgmt.labservices.models.ConnectionType
:keyword web_rdp_access: The enabled access level for Web Access over RDP. Possible values
include: "Public", "Private", "None".
:paramtype web_rdp_access: str or ~azure.mgmt.labservices.models.ConnectionType
:keyword client_ssh_access: The enabled access level for Client Access over SSH. Possible
values include: "Public", "Private", "None".
:paramtype client_ssh_access: str or ~azure.mgmt.labservices.models.ConnectionType
:keyword client_rdp_access: The enabled access level for Client Access over RDP. Possible
values include: "Public", "Private", "None".
:paramtype client_rdp_access: str or ~azure.mgmt.labservices.models.ConnectionType
"""
super(ConnectionProfile, self).__init__(**kwargs)
self.web_ssh_access = web_ssh_access
self.web_rdp_access = web_rdp_access
self.client_ssh_access = client_ssh_access
self.client_rdp_access = client_rdp_access
[docs]class Credentials(msrest.serialization.Model):
"""Credentials for a user on a lab VM.
All required parameters must be populated in order to send to Azure.
:ivar username: Required. The username to use when signing in to lab VMs.
:vartype username: str
:ivar password: The password for the user. This is required for the TemplateVM createOption.
:vartype password: str
"""
_validation = {
'username': {'required': True},
}
_attribute_map = {
'username': {'key': 'username', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
}
def __init__(
self,
*,
username: str,
password: Optional[str] = None,
**kwargs
):
"""
:keyword username: Required. The username to use when signing in to lab VMs.
:paramtype username: str
:keyword password: The password for the user. This is required for the TemplateVM createOption.
:paramtype password: str
"""
super(Credentials, self).__init__(**kwargs)
self.username = username
self.password = password
[docs]class ErrorAdditionalInfo(msrest.serialization.Model):
"""The resource management error additional info.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar type: The additional info type.
:vartype type: str
:ivar info: The additional info.
:vartype info: any
"""
_validation = {
'type': {'readonly': True},
'info': {'readonly': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'info': {'key': 'info', 'type': 'object'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(ErrorAdditionalInfo, self).__init__(**kwargs)
self.type = None
self.info = None
[docs]class ErrorDetail(msrest.serialization.Model):
"""The error detail.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: The error code.
:vartype code: str
:ivar message: The error message.
:vartype message: str
:ivar target: The error target.
:vartype target: str
:ivar details: The error details.
:vartype details: list[~azure.mgmt.labservices.models.ErrorDetail]
:ivar additional_info: The error additional info.
:vartype additional_info: list[~azure.mgmt.labservices.models.ErrorAdditionalInfo]
"""
_validation = {
'code': {'readonly': True},
'message': {'readonly': True},
'target': {'readonly': True},
'details': {'readonly': True},
'additional_info': {'readonly': True},
}
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
'target': {'key': 'target', 'type': 'str'},
'details': {'key': 'details', 'type': '[ErrorDetail]'},
'additional_info': {'key': 'additionalInfo', 'type': '[ErrorAdditionalInfo]'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(ErrorDetail, self).__init__(**kwargs)
self.code = None
self.message = None
self.target = None
self.details = None
self.additional_info = None
[docs]class ErrorResponse(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.).
:ivar error: The error object.
:vartype error: ~azure.mgmt.labservices.models.ErrorDetail
"""
_attribute_map = {
'error': {'key': 'error', 'type': 'ErrorDetail'},
}
def __init__(
self,
*,
error: Optional["ErrorDetail"] = None,
**kwargs
):
"""
:keyword error: The error object.
:paramtype error: ~azure.mgmt.labservices.models.ErrorDetail
"""
super(ErrorResponse, self).__init__(**kwargs)
self.error = error
[docs]class Resource(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class ProxyResource(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(ProxyResource, self).__init__(**kwargs)
[docs]class Image(ProxyResource):
"""Lab services virtual machine image.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Metadata pertaining to creation and last modification of the image.
:vartype system_data: ~azure.mgmt.labservices.models.SystemData
:ivar enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:vartype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
:ivar provisioning_state: Current provisioning state of the image. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar display_name: The image display name.
:vartype display_name: str
:ivar description: A description of the image.
:vartype description: str
:ivar icon_url: URL of the image icon.
:vartype icon_url: str
:ivar author: The image author.
:vartype author: str
:ivar os_type: The OS Type of the image. Possible values include: "Windows", "Linux".
:vartype os_type: str or ~azure.mgmt.labservices.models.OsType
:ivar plan: The ID of marketplace plan associated with the image (optional).
:vartype plan: str
:ivar terms_status: The status of image terms of use (enabled = accepted, disabled = not
accepted). Possible values include: "Enabled", "Disabled".
:vartype terms_status: str or ~azure.mgmt.labservices.models.EnableState
:ivar offer: The ID of an offer associated with the image.
:vartype offer: str
:ivar publisher: The ID of the publisher of the image.
:vartype publisher: str
:ivar sku: The image SKU.
:vartype sku: str
:ivar version: The image version.
:vartype version: str
:ivar shared_gallery_id: The ID for the image in the shared gallery.
:vartype shared_gallery_id: str
:ivar available_regions: The available regions of the image in the shared gallery.
:vartype available_regions: list[str]
:ivar os_state: The OS State of the image. Possible values include: "Generalized",
"Specialized".
:vartype os_state: str or ~azure.mgmt.labservices.models.OsState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'system_data': {'readonly': True},
'provisioning_state': {'readonly': True},
'display_name': {'readonly': True},
'description': {'readonly': True},
'icon_url': {'readonly': True},
'author': {'readonly': True},
'os_type': {'readonly': True},
'plan': {'readonly': True},
'terms_status': {'readonly': True},
'offer': {'readonly': True},
'publisher': {'readonly': True},
'sku': {'readonly': True},
'version': {'readonly': True},
'shared_gallery_id': {'readonly': True, 'max_length': 2000, 'min_length': 3},
'os_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'system_data': {'key': 'systemData', 'type': 'SystemData'},
'enabled_state': {'key': 'properties.enabledState', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'display_name': {'key': 'properties.displayName', 'type': 'str'},
'description': {'key': 'properties.description', 'type': 'str'},
'icon_url': {'key': 'properties.iconUrl', 'type': 'str'},
'author': {'key': 'properties.author', 'type': 'str'},
'os_type': {'key': 'properties.osType', 'type': 'str'},
'plan': {'key': 'properties.plan', 'type': 'str'},
'terms_status': {'key': 'properties.termsStatus', 'type': 'str'},
'offer': {'key': 'properties.offer', 'type': 'str'},
'publisher': {'key': 'properties.publisher', 'type': 'str'},
'sku': {'key': 'properties.sku', 'type': 'str'},
'version': {'key': 'properties.version', 'type': 'str'},
'shared_gallery_id': {'key': 'properties.sharedGalleryId', 'type': 'str'},
'available_regions': {'key': 'properties.availableRegions', 'type': '[str]'},
'os_state': {'key': 'properties.osState', 'type': 'str'},
}
def __init__(
self,
*,
enabled_state: Optional[Union[str, "EnableState"]] = None,
available_regions: Optional[List[str]] = None,
**kwargs
):
"""
:keyword enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:paramtype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
:keyword available_regions: The available regions of the image in the shared gallery.
:paramtype available_regions: list[str]
"""
super(Image, self).__init__(**kwargs)
self.system_data = None
self.enabled_state = enabled_state
self.provisioning_state = None
self.display_name = None
self.description = None
self.icon_url = None
self.author = None
self.os_type = None
self.plan = None
self.terms_status = None
self.offer = None
self.publisher = None
self.sku = None
self.version = None
self.shared_gallery_id = None
self.available_regions = available_regions
self.os_state = None
[docs]class ImageUpdateProperties(msrest.serialization.Model):
"""Properties of an image resource update.
:ivar enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:vartype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
"""
_attribute_map = {
'enabled_state': {'key': 'enabledState', 'type': 'str'},
}
def __init__(
self,
*,
enabled_state: Optional[Union[str, "EnableState"]] = None,
**kwargs
):
"""
:keyword enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:paramtype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
"""
super(ImageUpdateProperties, self).__init__(**kwargs)
self.enabled_state = enabled_state
[docs]class ImageProperties(ImageUpdateProperties):
"""Properties of an image resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:vartype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
:ivar provisioning_state: Current provisioning state of the image. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar display_name: The image display name.
:vartype display_name: str
:ivar description: A description of the image.
:vartype description: str
:ivar icon_url: URL of the image icon.
:vartype icon_url: str
:ivar author: The image author.
:vartype author: str
:ivar os_type: The OS Type of the image. Possible values include: "Windows", "Linux".
:vartype os_type: str or ~azure.mgmt.labservices.models.OsType
:ivar plan: The ID of marketplace plan associated with the image (optional).
:vartype plan: str
:ivar terms_status: The status of image terms of use (enabled = accepted, disabled = not
accepted). Possible values include: "Enabled", "Disabled".
:vartype terms_status: str or ~azure.mgmt.labservices.models.EnableState
:ivar offer: The ID of an offer associated with the image.
:vartype offer: str
:ivar publisher: The ID of the publisher of the image.
:vartype publisher: str
:ivar sku: The image SKU.
:vartype sku: str
:ivar version: The image version.
:vartype version: str
:ivar shared_gallery_id: The ID for the image in the shared gallery.
:vartype shared_gallery_id: str
:ivar available_regions: The available regions of the image in the shared gallery.
:vartype available_regions: list[str]
:ivar os_state: The OS State of the image. Possible values include: "Generalized",
"Specialized".
:vartype os_state: str or ~azure.mgmt.labservices.models.OsState
"""
_validation = {
'provisioning_state': {'readonly': True},
'display_name': {'readonly': True},
'description': {'readonly': True},
'icon_url': {'readonly': True},
'author': {'readonly': True},
'os_type': {'readonly': True},
'plan': {'readonly': True},
'terms_status': {'readonly': True},
'offer': {'readonly': True},
'publisher': {'readonly': True},
'sku': {'readonly': True},
'version': {'readonly': True},
'shared_gallery_id': {'readonly': True, 'max_length': 2000, 'min_length': 3},
'os_state': {'readonly': True},
}
_attribute_map = {
'enabled_state': {'key': 'enabledState', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'display_name': {'key': 'displayName', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
'icon_url': {'key': 'iconUrl', 'type': 'str'},
'author': {'key': 'author', 'type': 'str'},
'os_type': {'key': 'osType', 'type': 'str'},
'plan': {'key': 'plan', 'type': 'str'},
'terms_status': {'key': 'termsStatus', 'type': 'str'},
'offer': {'key': 'offer', 'type': 'str'},
'publisher': {'key': 'publisher', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'str'},
'version': {'key': 'version', 'type': 'str'},
'shared_gallery_id': {'key': 'sharedGalleryId', 'type': 'str'},
'available_regions': {'key': 'availableRegions', 'type': '[str]'},
'os_state': {'key': 'osState', 'type': 'str'},
}
def __init__(
self,
*,
enabled_state: Optional[Union[str, "EnableState"]] = None,
available_regions: Optional[List[str]] = None,
**kwargs
):
"""
:keyword enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:paramtype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
:keyword available_regions: The available regions of the image in the shared gallery.
:paramtype available_regions: list[str]
"""
super(ImageProperties, self).__init__(enabled_state=enabled_state, **kwargs)
self.provisioning_state = None
self.display_name = None
self.description = None
self.icon_url = None
self.author = None
self.os_type = None
self.plan = None
self.terms_status = None
self.offer = None
self.publisher = None
self.sku = None
self.version = None
self.shared_gallery_id = None
self.available_regions = available_regions
self.os_state = None
[docs]class ImageReference(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.
:ivar id: Image resource ID.
:vartype id: str
:ivar offer: The image offer if applicable.
:vartype offer: str
:ivar publisher: The image publisher.
:vartype publisher: str
:ivar sku: The image SKU.
:vartype sku: str
:ivar version: The image version specified on creation.
:vartype version: str
:ivar exact_version: The actual version of the image after use.
:vartype exact_version: str
"""
_validation = {
'id': {'max_length': 2000, 'min_length': 3},
'exact_version': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'offer': {'key': 'offer', 'type': 'str'},
'publisher': {'key': 'publisher', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'str'},
'version': {'key': 'version', 'type': 'str'},
'exact_version': {'key': 'exactVersion', 'type': 'str'},
}
def __init__(
self,
*,
id: Optional[str] = None,
offer: Optional[str] = None,
publisher: Optional[str] = None,
sku: Optional[str] = None,
version: Optional[str] = None,
**kwargs
):
"""
:keyword id: Image resource ID.
:paramtype id: str
:keyword offer: The image offer if applicable.
:paramtype offer: str
:keyword publisher: The image publisher.
:paramtype publisher: str
:keyword sku: The image SKU.
:paramtype sku: str
:keyword version: The image version specified on creation.
:paramtype version: str
"""
super(ImageReference, self).__init__(**kwargs)
self.id = id
self.offer = offer
self.publisher = publisher
self.sku = sku
self.version = version
self.exact_version = None
[docs]class ImageUpdate(msrest.serialization.Model):
"""Lab services virtual machine image for updates.
:ivar enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:vartype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
"""
_attribute_map = {
'enabled_state': {'key': 'properties.enabledState', 'type': 'str'},
}
def __init__(
self,
*,
enabled_state: Optional[Union[str, "EnableState"]] = None,
**kwargs
):
"""
:keyword enabled_state: Is the image enabled. Possible values include: "Enabled", "Disabled".
:paramtype enabled_state: str or ~azure.mgmt.labservices.models.EnableState
"""
super(ImageUpdate, self).__init__(**kwargs)
self.enabled_state = enabled_state
[docs]class InviteBody(msrest.serialization.Model):
"""Body for a user invite request.
:ivar text: Custom text for the invite email.
:vartype text: str
"""
_attribute_map = {
'text': {'key': 'text', 'type': 'str'},
}
def __init__(
self,
*,
text: Optional[str] = None,
**kwargs
):
"""
:keyword text: Custom text for the invite email.
:paramtype text: str
"""
super(InviteBody, self).__init__(**kwargs)
self.text = text
[docs]class TrackedResource(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar location: Required. The geo-location where the resource lives.
:vartype location: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: dict[str, str]
:keyword location: Required. The geo-location where the resource lives.
:paramtype location: str
"""
super(TrackedResource, self).__init__(**kwargs)
self.tags = tags
self.location = location
[docs]class Lab(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar location: Required. The geo-location where the resource lives.
:vartype location: str
:ivar system_data: Metadata pertaining to creation and last modification of the lab.
:vartype system_data: ~azure.mgmt.labservices.models.SystemData
:ivar auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:vartype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:vartype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar virtual_machine_profile: The profile used for creating lab virtual machines.
:vartype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:ivar security_profile: The lab security profile.
:vartype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:ivar roster_profile: The lab user list management profile.
:vartype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:ivar lab_plan_id: 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..
:vartype lab_plan_id: str
:ivar title: The title of the lab.
:vartype title: str
:ivar description: The description of the lab.
:vartype description: str
:ivar provisioning_state: Current provisioning state of the lab. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar network_profile: The network profile for the lab, typically applied via a lab plan. This
profile cannot be modified once a lab has been created.
:vartype network_profile: ~azure.mgmt.labservices.models.LabNetworkProfile
:ivar state: The lab state. Possible values include: "Draft", "Publishing", "Scaling",
"Syncing", "Published".
:vartype state: str or ~azure.mgmt.labservices.models.LabState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'system_data': {'readonly': True},
'lab_plan_id': {'max_length': 2000, 'min_length': 3},
'title': {'max_length': 120, 'min_length': 1},
'provisioning_state': {'readonly': True},
'state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
'system_data': {'key': 'systemData', 'type': 'SystemData'},
'auto_shutdown_profile': {'key': 'properties.autoShutdownProfile', 'type': 'AutoShutdownProfile'},
'connection_profile': {'key': 'properties.connectionProfile', 'type': 'ConnectionProfile'},
'virtual_machine_profile': {'key': 'properties.virtualMachineProfile', 'type': 'VirtualMachineProfile'},
'security_profile': {'key': 'properties.securityProfile', 'type': 'SecurityProfile'},
'roster_profile': {'key': 'properties.rosterProfile', 'type': 'RosterProfile'},
'lab_plan_id': {'key': 'properties.labPlanId', 'type': 'str'},
'title': {'key': 'properties.title', 'type': 'str'},
'description': {'key': 'properties.description', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'network_profile': {'key': 'properties.networkProfile', 'type': 'LabNetworkProfile'},
'state': {'key': 'properties.state', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
connection_profile: Optional["ConnectionProfile"] = None,
virtual_machine_profile: Optional["VirtualMachineProfile"] = None,
security_profile: Optional["SecurityProfile"] = None,
roster_profile: Optional["RosterProfile"] = None,
lab_plan_id: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
network_profile: Optional["LabNetworkProfile"] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: dict[str, str]
:keyword location: Required. The geo-location where the resource lives.
:paramtype location: str
:keyword auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:paramtype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:paramtype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword virtual_machine_profile: The profile used for creating lab virtual machines.
:paramtype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:keyword security_profile: The lab security profile.
:paramtype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:keyword roster_profile: The lab user list management profile.
:paramtype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:keyword lab_plan_id: 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..
:paramtype lab_plan_id: str
:keyword title: The title of the lab.
:paramtype title: str
:keyword description: The description of the lab.
:paramtype description: str
:keyword network_profile: The network profile for the lab, typically applied via a lab plan.
This profile cannot be modified once a lab has been created.
:paramtype network_profile: ~azure.mgmt.labservices.models.LabNetworkProfile
"""
super(Lab, self).__init__(tags=tags, location=location, **kwargs)
self.system_data = None
self.auto_shutdown_profile = auto_shutdown_profile
self.connection_profile = connection_profile
self.virtual_machine_profile = virtual_machine_profile
self.security_profile = security_profile
self.roster_profile = roster_profile
self.lab_plan_id = lab_plan_id
self.title = title
self.description = description
self.provisioning_state = None
self.network_profile = network_profile
self.state = None
[docs]class LabNetworkProfile(msrest.serialization.Model):
"""Profile for how to handle networking for Labs.
:ivar subnet_id: The external subnet resource id.
:vartype subnet_id: str
:ivar load_balancer_id: The external load balancer resource id.
:vartype load_balancer_id: str
:ivar public_ip_id: The external public IP resource id.
:vartype public_ip_id: str
"""
_validation = {
'subnet_id': {'max_length': 2000, 'min_length': 3},
'load_balancer_id': {'max_length': 2000, 'min_length': 3},
'public_ip_id': {'max_length': 2000, 'min_length': 3},
}
_attribute_map = {
'subnet_id': {'key': 'subnetId', 'type': 'str'},
'load_balancer_id': {'key': 'loadBalancerId', 'type': 'str'},
'public_ip_id': {'key': 'publicIpId', 'type': 'str'},
}
def __init__(
self,
*,
subnet_id: Optional[str] = None,
load_balancer_id: Optional[str] = None,
public_ip_id: Optional[str] = None,
**kwargs
):
"""
:keyword subnet_id: The external subnet resource id.
:paramtype subnet_id: str
:keyword load_balancer_id: The external load balancer resource id.
:paramtype load_balancer_id: str
:keyword public_ip_id: The external public IP resource id.
:paramtype public_ip_id: str
"""
super(LabNetworkProfile, self).__init__(**kwargs)
self.subnet_id = subnet_id
self.load_balancer_id = load_balancer_id
self.public_ip_id = public_ip_id
[docs]class LabPlan(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar location: Required. The geo-location where the resource lives.
:vartype location: str
:ivar system_data: Metadata pertaining to creation and last modification of the lab plan.
:vartype system_data: ~azure.mgmt.labservices.models.SystemData
:ivar default_connection_profile: The default lab connection profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar default_auto_shutdown_profile: The default lab shutdown profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar default_network_profile: 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.
:vartype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:ivar allowed_regions: The allowed regions for the lab creator to use when creating labs using
this lab plan.
:vartype allowed_regions: list[str]
:ivar shared_gallery_id: 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.
:vartype shared_gallery_id: str
:ivar support_info: 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.
:vartype support_info: ~azure.mgmt.labservices.models.SupportInfo
:ivar linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:vartype linked_lms_instance: str
:ivar provisioning_state: Current provisioning state of the lab plan. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'system_data': {'readonly': True},
'shared_gallery_id': {'max_length': 2000, 'min_length': 3},
'linked_lms_instance': {'max_length': 2000, 'min_length': 3},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
'system_data': {'key': 'systemData', 'type': 'SystemData'},
'default_connection_profile': {'key': 'properties.defaultConnectionProfile', 'type': 'ConnectionProfile'},
'default_auto_shutdown_profile': {'key': 'properties.defaultAutoShutdownProfile', 'type': 'AutoShutdownProfile'},
'default_network_profile': {'key': 'properties.defaultNetworkProfile', 'type': 'LabPlanNetworkProfile'},
'allowed_regions': {'key': 'properties.allowedRegions', 'type': '[str]'},
'shared_gallery_id': {'key': 'properties.sharedGalleryId', 'type': 'str'},
'support_info': {'key': 'properties.supportInfo', 'type': 'SupportInfo'},
'linked_lms_instance': {'key': 'properties.linkedLmsInstance', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
default_connection_profile: Optional["ConnectionProfile"] = None,
default_auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
default_network_profile: Optional["LabPlanNetworkProfile"] = None,
allowed_regions: Optional[List[str]] = None,
shared_gallery_id: Optional[str] = None,
support_info: Optional["SupportInfo"] = None,
linked_lms_instance: Optional[str] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: dict[str, str]
:keyword location: Required. The geo-location where the resource lives.
:paramtype location: str
:keyword default_connection_profile: The default lab connection profile. This can be changed on
a lab resource and only provides a default profile.
:paramtype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword default_auto_shutdown_profile: The default lab shutdown profile. This can be changed
on a lab resource and only provides a default profile.
:paramtype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword default_network_profile: 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.
:paramtype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:keyword allowed_regions: The allowed regions for the lab creator to use when creating labs
using this lab plan.
:paramtype allowed_regions: list[str]
:keyword shared_gallery_id: 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.
:paramtype shared_gallery_id: str
:keyword support_info: 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.
:paramtype support_info: ~azure.mgmt.labservices.models.SupportInfo
:keyword linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:paramtype linked_lms_instance: str
"""
super(LabPlan, self).__init__(tags=tags, location=location, **kwargs)
self.system_data = None
self.default_connection_profile = default_connection_profile
self.default_auto_shutdown_profile = default_auto_shutdown_profile
self.default_network_profile = default_network_profile
self.allowed_regions = allowed_regions
self.shared_gallery_id = shared_gallery_id
self.support_info = support_info
self.linked_lms_instance = linked_lms_instance
self.provisioning_state = None
[docs]class LabPlanNetworkProfile(msrest.serialization.Model):
"""Profile for how to handle networking for Lab Plans.
:ivar subnet_id: The external subnet resource id.
:vartype subnet_id: str
"""
_validation = {
'subnet_id': {'max_length': 2000, 'min_length': 3},
}
_attribute_map = {
'subnet_id': {'key': 'subnetId', 'type': 'str'},
}
def __init__(
self,
*,
subnet_id: Optional[str] = None,
**kwargs
):
"""
:keyword subnet_id: The external subnet resource id.
:paramtype subnet_id: str
"""
super(LabPlanNetworkProfile, self).__init__(**kwargs)
self.subnet_id = subnet_id
[docs]class LabPlanUpdateProperties(msrest.serialization.Model):
"""Lab plan resource properties for updates.
:ivar default_connection_profile: The default lab connection profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar default_auto_shutdown_profile: The default lab shutdown profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar default_network_profile: 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.
:vartype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:ivar allowed_regions: The allowed regions for the lab creator to use when creating labs using
this lab plan.
:vartype allowed_regions: list[str]
:ivar shared_gallery_id: 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.
:vartype shared_gallery_id: str
:ivar support_info: 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.
:vartype support_info: ~azure.mgmt.labservices.models.SupportInfo
:ivar linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:vartype linked_lms_instance: str
"""
_validation = {
'shared_gallery_id': {'max_length': 2000, 'min_length': 3},
'linked_lms_instance': {'max_length': 2000, 'min_length': 3},
}
_attribute_map = {
'default_connection_profile': {'key': 'defaultConnectionProfile', 'type': 'ConnectionProfile'},
'default_auto_shutdown_profile': {'key': 'defaultAutoShutdownProfile', 'type': 'AutoShutdownProfile'},
'default_network_profile': {'key': 'defaultNetworkProfile', 'type': 'LabPlanNetworkProfile'},
'allowed_regions': {'key': 'allowedRegions', 'type': '[str]'},
'shared_gallery_id': {'key': 'sharedGalleryId', 'type': 'str'},
'support_info': {'key': 'supportInfo', 'type': 'SupportInfo'},
'linked_lms_instance': {'key': 'linkedLmsInstance', 'type': 'str'},
}
def __init__(
self,
*,
default_connection_profile: Optional["ConnectionProfile"] = None,
default_auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
default_network_profile: Optional["LabPlanNetworkProfile"] = None,
allowed_regions: Optional[List[str]] = None,
shared_gallery_id: Optional[str] = None,
support_info: Optional["SupportInfo"] = None,
linked_lms_instance: Optional[str] = None,
**kwargs
):
"""
:keyword default_connection_profile: The default lab connection profile. This can be changed on
a lab resource and only provides a default profile.
:paramtype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword default_auto_shutdown_profile: The default lab shutdown profile. This can be changed
on a lab resource and only provides a default profile.
:paramtype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword default_network_profile: 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.
:paramtype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:keyword allowed_regions: The allowed regions for the lab creator to use when creating labs
using this lab plan.
:paramtype allowed_regions: list[str]
:keyword shared_gallery_id: 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.
:paramtype shared_gallery_id: str
:keyword support_info: 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.
:paramtype support_info: ~azure.mgmt.labservices.models.SupportInfo
:keyword linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:paramtype linked_lms_instance: str
"""
super(LabPlanUpdateProperties, self).__init__(**kwargs)
self.default_connection_profile = default_connection_profile
self.default_auto_shutdown_profile = default_auto_shutdown_profile
self.default_network_profile = default_network_profile
self.allowed_regions = allowed_regions
self.shared_gallery_id = shared_gallery_id
self.support_info = support_info
self.linked_lms_instance = linked_lms_instance
[docs]class LabPlanProperties(LabPlanUpdateProperties):
"""Lab plan resource properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar default_connection_profile: The default lab connection profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar default_auto_shutdown_profile: The default lab shutdown profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar default_network_profile: 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.
:vartype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:ivar allowed_regions: The allowed regions for the lab creator to use when creating labs using
this lab plan.
:vartype allowed_regions: list[str]
:ivar shared_gallery_id: 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.
:vartype shared_gallery_id: str
:ivar support_info: 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.
:vartype support_info: ~azure.mgmt.labservices.models.SupportInfo
:ivar linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:vartype linked_lms_instance: str
:ivar provisioning_state: Current provisioning state of the lab plan. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
"""
_validation = {
'shared_gallery_id': {'max_length': 2000, 'min_length': 3},
'linked_lms_instance': {'max_length': 2000, 'min_length': 3},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'default_connection_profile': {'key': 'defaultConnectionProfile', 'type': 'ConnectionProfile'},
'default_auto_shutdown_profile': {'key': 'defaultAutoShutdownProfile', 'type': 'AutoShutdownProfile'},
'default_network_profile': {'key': 'defaultNetworkProfile', 'type': 'LabPlanNetworkProfile'},
'allowed_regions': {'key': 'allowedRegions', 'type': '[str]'},
'shared_gallery_id': {'key': 'sharedGalleryId', 'type': 'str'},
'support_info': {'key': 'supportInfo', 'type': 'SupportInfo'},
'linked_lms_instance': {'key': 'linkedLmsInstance', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
default_connection_profile: Optional["ConnectionProfile"] = None,
default_auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
default_network_profile: Optional["LabPlanNetworkProfile"] = None,
allowed_regions: Optional[List[str]] = None,
shared_gallery_id: Optional[str] = None,
support_info: Optional["SupportInfo"] = None,
linked_lms_instance: Optional[str] = None,
**kwargs
):
"""
:keyword default_connection_profile: The default lab connection profile. This can be changed on
a lab resource and only provides a default profile.
:paramtype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword default_auto_shutdown_profile: The default lab shutdown profile. This can be changed
on a lab resource and only provides a default profile.
:paramtype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword default_network_profile: 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.
:paramtype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:keyword allowed_regions: The allowed regions for the lab creator to use when creating labs
using this lab plan.
:paramtype allowed_regions: list[str]
:keyword shared_gallery_id: 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.
:paramtype shared_gallery_id: str
:keyword support_info: 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.
:paramtype support_info: ~azure.mgmt.labservices.models.SupportInfo
:keyword linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:paramtype linked_lms_instance: str
"""
super(LabPlanProperties, self).__init__(default_connection_profile=default_connection_profile, default_auto_shutdown_profile=default_auto_shutdown_profile, default_network_profile=default_network_profile, allowed_regions=allowed_regions, shared_gallery_id=shared_gallery_id, support_info=support_info, linked_lms_instance=linked_lms_instance, **kwargs)
self.provisioning_state = None
[docs]class TrackedResourceUpdate(msrest.serialization.Model):
"""Base tracked resource type for all PATCH updates.
:ivar tags: A set of tags. Resource tags.
:vartype tags: list[str]
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '[str]'},
}
def __init__(
self,
*,
tags: Optional[List[str]] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: list[str]
"""
super(TrackedResourceUpdate, self).__init__(**kwargs)
self.tags = tags
[docs]class LabPlanUpdate(TrackedResourceUpdate):
"""Contains lab configuration and default settings. This variant is used for PATCH.
:ivar tags: A set of tags. Resource tags.
:vartype tags: list[str]
:ivar default_connection_profile: The default lab connection profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar default_auto_shutdown_profile: The default lab shutdown profile. This can be changed on a
lab resource and only provides a default profile.
:vartype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar default_network_profile: 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.
:vartype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:ivar allowed_regions: The allowed regions for the lab creator to use when creating labs using
this lab plan.
:vartype allowed_regions: list[str]
:ivar shared_gallery_id: 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.
:vartype shared_gallery_id: str
:ivar support_info: 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.
:vartype support_info: ~azure.mgmt.labservices.models.SupportInfo
:ivar linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:vartype linked_lms_instance: str
"""
_validation = {
'shared_gallery_id': {'max_length': 2000, 'min_length': 3},
'linked_lms_instance': {'max_length': 2000, 'min_length': 3},
}
_attribute_map = {
'tags': {'key': 'tags', 'type': '[str]'},
'default_connection_profile': {'key': 'properties.defaultConnectionProfile', 'type': 'ConnectionProfile'},
'default_auto_shutdown_profile': {'key': 'properties.defaultAutoShutdownProfile', 'type': 'AutoShutdownProfile'},
'default_network_profile': {'key': 'properties.defaultNetworkProfile', 'type': 'LabPlanNetworkProfile'},
'allowed_regions': {'key': 'properties.allowedRegions', 'type': '[str]'},
'shared_gallery_id': {'key': 'properties.sharedGalleryId', 'type': 'str'},
'support_info': {'key': 'properties.supportInfo', 'type': 'SupportInfo'},
'linked_lms_instance': {'key': 'properties.linkedLmsInstance', 'type': 'str'},
}
def __init__(
self,
*,
tags: Optional[List[str]] = None,
default_connection_profile: Optional["ConnectionProfile"] = None,
default_auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
default_network_profile: Optional["LabPlanNetworkProfile"] = None,
allowed_regions: Optional[List[str]] = None,
shared_gallery_id: Optional[str] = None,
support_info: Optional["SupportInfo"] = None,
linked_lms_instance: Optional[str] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: list[str]
:keyword default_connection_profile: The default lab connection profile. This can be changed on
a lab resource and only provides a default profile.
:paramtype default_connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword default_auto_shutdown_profile: The default lab shutdown profile. This can be changed
on a lab resource and only provides a default profile.
:paramtype default_auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword default_network_profile: 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.
:paramtype default_network_profile: ~azure.mgmt.labservices.models.LabPlanNetworkProfile
:keyword allowed_regions: The allowed regions for the lab creator to use when creating labs
using this lab plan.
:paramtype allowed_regions: list[str]
:keyword shared_gallery_id: 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.
:paramtype shared_gallery_id: str
:keyword support_info: 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.
:paramtype support_info: ~azure.mgmt.labservices.models.SupportInfo
:keyword linked_lms_instance: Base Url of the lms instance this lab plan can link lab rosters
against.
:paramtype linked_lms_instance: str
"""
super(LabPlanUpdate, self).__init__(tags=tags, **kwargs)
self.default_connection_profile = default_connection_profile
self.default_auto_shutdown_profile = default_auto_shutdown_profile
self.default_network_profile = default_network_profile
self.allowed_regions = allowed_regions
self.shared_gallery_id = shared_gallery_id
self.support_info = support_info
self.linked_lms_instance = linked_lms_instance
[docs]class LabUpdateProperties(msrest.serialization.Model):
"""Properties of a lab resource used for updates.
:ivar auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:vartype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:vartype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar virtual_machine_profile: The profile used for creating lab virtual machines.
:vartype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:ivar security_profile: The lab security profile.
:vartype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:ivar roster_profile: The lab user list management profile.
:vartype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:ivar lab_plan_id: 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..
:vartype lab_plan_id: str
:ivar title: The title of the lab.
:vartype title: str
:ivar description: The description of the lab.
:vartype description: str
"""
_validation = {
'lab_plan_id': {'max_length': 2000, 'min_length': 3},
'title': {'max_length': 120, 'min_length': 1},
}
_attribute_map = {
'auto_shutdown_profile': {'key': 'autoShutdownProfile', 'type': 'AutoShutdownProfile'},
'connection_profile': {'key': 'connectionProfile', 'type': 'ConnectionProfile'},
'virtual_machine_profile': {'key': 'virtualMachineProfile', 'type': 'VirtualMachineProfile'},
'security_profile': {'key': 'securityProfile', 'type': 'SecurityProfile'},
'roster_profile': {'key': 'rosterProfile', 'type': 'RosterProfile'},
'lab_plan_id': {'key': 'labPlanId', 'type': 'str'},
'title': {'key': 'title', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
}
def __init__(
self,
*,
auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
connection_profile: Optional["ConnectionProfile"] = None,
virtual_machine_profile: Optional["VirtualMachineProfile"] = None,
security_profile: Optional["SecurityProfile"] = None,
roster_profile: Optional["RosterProfile"] = None,
lab_plan_id: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
**kwargs
):
"""
:keyword auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:paramtype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:paramtype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword virtual_machine_profile: The profile used for creating lab virtual machines.
:paramtype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:keyword security_profile: The lab security profile.
:paramtype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:keyword roster_profile: The lab user list management profile.
:paramtype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:keyword lab_plan_id: 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..
:paramtype lab_plan_id: str
:keyword title: The title of the lab.
:paramtype title: str
:keyword description: The description of the lab.
:paramtype description: str
"""
super(LabUpdateProperties, self).__init__(**kwargs)
self.auto_shutdown_profile = auto_shutdown_profile
self.connection_profile = connection_profile
self.virtual_machine_profile = virtual_machine_profile
self.security_profile = security_profile
self.roster_profile = roster_profile
self.lab_plan_id = lab_plan_id
self.title = title
self.description = description
[docs]class LabProperties(LabUpdateProperties):
"""Properties of a lab resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:vartype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:vartype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar virtual_machine_profile: The profile used for creating lab virtual machines.
:vartype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:ivar security_profile: The lab security profile.
:vartype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:ivar roster_profile: The lab user list management profile.
:vartype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:ivar lab_plan_id: 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..
:vartype lab_plan_id: str
:ivar title: The title of the lab.
:vartype title: str
:ivar description: The description of the lab.
:vartype description: str
:ivar provisioning_state: Current provisioning state of the lab. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar network_profile: The network profile for the lab, typically applied via a lab plan. This
profile cannot be modified once a lab has been created.
:vartype network_profile: ~azure.mgmt.labservices.models.LabNetworkProfile
:ivar state: The lab state. Possible values include: "Draft", "Publishing", "Scaling",
"Syncing", "Published".
:vartype state: str or ~azure.mgmt.labservices.models.LabState
"""
_validation = {
'lab_plan_id': {'max_length': 2000, 'min_length': 3},
'title': {'max_length': 120, 'min_length': 1},
'provisioning_state': {'readonly': True},
'state': {'readonly': True},
}
_attribute_map = {
'auto_shutdown_profile': {'key': 'autoShutdownProfile', 'type': 'AutoShutdownProfile'},
'connection_profile': {'key': 'connectionProfile', 'type': 'ConnectionProfile'},
'virtual_machine_profile': {'key': 'virtualMachineProfile', 'type': 'VirtualMachineProfile'},
'security_profile': {'key': 'securityProfile', 'type': 'SecurityProfile'},
'roster_profile': {'key': 'rosterProfile', 'type': 'RosterProfile'},
'lab_plan_id': {'key': 'labPlanId', 'type': 'str'},
'title': {'key': 'title', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'network_profile': {'key': 'networkProfile', 'type': 'LabNetworkProfile'},
'state': {'key': 'state', 'type': 'str'},
}
def __init__(
self,
*,
auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
connection_profile: Optional["ConnectionProfile"] = None,
virtual_machine_profile: Optional["VirtualMachineProfile"] = None,
security_profile: Optional["SecurityProfile"] = None,
roster_profile: Optional["RosterProfile"] = None,
lab_plan_id: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
network_profile: Optional["LabNetworkProfile"] = None,
**kwargs
):
"""
:keyword auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:paramtype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:paramtype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword virtual_machine_profile: The profile used for creating lab virtual machines.
:paramtype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:keyword security_profile: The lab security profile.
:paramtype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:keyword roster_profile: The lab user list management profile.
:paramtype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:keyword lab_plan_id: 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..
:paramtype lab_plan_id: str
:keyword title: The title of the lab.
:paramtype title: str
:keyword description: The description of the lab.
:paramtype description: str
:keyword network_profile: The network profile for the lab, typically applied via a lab plan.
This profile cannot be modified once a lab has been created.
:paramtype network_profile: ~azure.mgmt.labservices.models.LabNetworkProfile
"""
super(LabProperties, self).__init__(auto_shutdown_profile=auto_shutdown_profile, connection_profile=connection_profile, virtual_machine_profile=virtual_machine_profile, security_profile=security_profile, roster_profile=roster_profile, lab_plan_id=lab_plan_id, title=title, description=description, **kwargs)
self.provisioning_state = None
self.network_profile = network_profile
self.state = None
[docs]class LabServicesSku(msrest.serialization.Model):
"""Azure Lab Services resource SKUs.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar resource_type: The lab services resource type.
:vartype resource_type: str
:ivar name: The name of the SKU.
:vartype name: str
:ivar tier: The tier of the SKU. Possible values include: "Standard", "Premium".
:vartype tier: str or ~azure.mgmt.labservices.models.LabServicesSkuTier
:ivar size: The SKU size.
:vartype size: str
:ivar family: The family of the SKU.
:vartype family: str
:ivar capacity: The scale out/in options of the SKU.
:vartype capacity: ~azure.mgmt.labservices.models.LabServicesSkuCapacity
:ivar capabilities: The capabilities of the SKU.
:vartype capabilities: list[~azure.mgmt.labservices.models.LabServicesSkuCapabilities]
:ivar locations: List of locations that are available for a size.
:vartype locations: list[str]
:ivar costs: Metadata for retrieving price info of a lab services SKUs.
:vartype costs: list[~azure.mgmt.labservices.models.LabServicesSkuCost]
:ivar restrictions: Restrictions of a lab services SKUs.
:vartype restrictions: list[~azure.mgmt.labservices.models.LabServicesSkuRestrictions]
"""
_validation = {
'resource_type': {'readonly': True},
'name': {'readonly': True},
'tier': {'readonly': True},
'size': {'readonly': True},
'family': {'readonly': True},
'capabilities': {'readonly': True},
'locations': {'readonly': True},
'costs': {'readonly': True},
'restrictions': {'readonly': True},
}
_attribute_map = {
'resource_type': {'key': 'resourceType', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
'size': {'key': 'size', 'type': 'str'},
'family': {'key': 'family', 'type': 'str'},
'capacity': {'key': 'capacity', 'type': 'LabServicesSkuCapacity'},
'capabilities': {'key': 'capabilities', 'type': '[LabServicesSkuCapabilities]'},
'locations': {'key': 'locations', 'type': '[str]'},
'costs': {'key': 'costs', 'type': '[LabServicesSkuCost]'},
'restrictions': {'key': 'restrictions', 'type': '[LabServicesSkuRestrictions]'},
}
def __init__(
self,
*,
capacity: Optional["LabServicesSkuCapacity"] = None,
**kwargs
):
"""
:keyword capacity: The scale out/in options of the SKU.
:paramtype capacity: ~azure.mgmt.labservices.models.LabServicesSkuCapacity
"""
super(LabServicesSku, self).__init__(**kwargs)
self.resource_type = None
self.name = None
self.tier = None
self.size = None
self.family = None
self.capacity = capacity
self.capabilities = None
self.locations = None
self.costs = None
self.restrictions = None
[docs]class LabServicesSkuCapabilities(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.
:ivar name: The name of the capability for a SKU.
:vartype name: str
:ivar value: The value of the capability for a SKU.
:vartype value: str
"""
_validation = {
'name': {'readonly': True},
'value': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(LabServicesSkuCapabilities, self).__init__(**kwargs)
self.name = None
self.value = None
[docs]class LabServicesSkuCapacity(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.
:ivar default: The default capacity for this resource.
:vartype default: long
:ivar minimum: The lowest permitted capacity for this resource.
:vartype minimum: long
:ivar maximum: The highest permitted capacity for this resource.
:vartype maximum: long
:ivar scale_type: The localized name of the resource. Possible values include: "None",
"Manual", "Automatic".
:vartype scale_type: str or ~azure.mgmt.labservices.models.ScaleType
"""
_validation = {
'default': {'readonly': True},
'minimum': {'readonly': True},
'maximum': {'readonly': True},
'scale_type': {'readonly': True},
}
_attribute_map = {
'default': {'key': 'default', 'type': 'long'},
'minimum': {'key': 'minimum', 'type': 'long'},
'maximum': {'key': 'maximum', 'type': 'long'},
'scale_type': {'key': 'scaleType', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(LabServicesSkuCapacity, self).__init__(**kwargs)
self.default = None
self.minimum = None
self.maximum = None
self.scale_type = None
[docs]class LabServicesSkuCost(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.
:ivar meter_id: The meter id.
:vartype meter_id: str
:ivar quantity: The quantity of units charged.
:vartype quantity: float
:ivar extended_unit: The extended unit.
:vartype extended_unit: str
"""
_validation = {
'meter_id': {'readonly': True},
'quantity': {'readonly': True},
'extended_unit': {'readonly': True},
}
_attribute_map = {
'meter_id': {'key': 'meterId', 'type': 'str'},
'quantity': {'key': 'quantity', 'type': 'float'},
'extended_unit': {'key': 'extendedUnit', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(LabServicesSkuCost, self).__init__(**kwargs)
self.meter_id = None
self.quantity = None
self.extended_unit = None
[docs]class LabServicesSkuRestrictions(msrest.serialization.Model):
"""The restriction details.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar type: The type of restriction. Possible values include: "Location".
:vartype type: str or ~azure.mgmt.labservices.models.RestrictionType
:ivar values: The values of the restriction.
:vartype values: list[str]
:ivar reason_code: The reason for the restriction. Possible values include: "QuotaId",
"NotAvailableForSubscription".
:vartype reason_code: str or ~azure.mgmt.labservices.models.RestrictionReasonCode
"""
_validation = {
'type': {'readonly': True},
'values': {'readonly': True},
'reason_code': {'readonly': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'values': {'key': 'values', 'type': '[str]'},
'reason_code': {'key': 'reasonCode', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(LabServicesSkuRestrictions, self).__init__(**kwargs)
self.type = None
self.values = None
self.reason_code = None
[docs]class LabUpdate(TrackedResourceUpdate):
"""The lab resource for updates.
:ivar tags: A set of tags. Resource tags.
:vartype tags: list[str]
:ivar auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:vartype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:ivar connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:vartype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:ivar virtual_machine_profile: The profile used for creating lab virtual machines.
:vartype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:ivar security_profile: The lab security profile.
:vartype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:ivar roster_profile: The lab user list management profile.
:vartype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:ivar lab_plan_id: 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..
:vartype lab_plan_id: str
:ivar title: The title of the lab.
:vartype title: str
:ivar description: The description of the lab.
:vartype description: str
"""
_validation = {
'lab_plan_id': {'max_length': 2000, 'min_length': 3},
'title': {'max_length': 120, 'min_length': 1},
}
_attribute_map = {
'tags': {'key': 'tags', 'type': '[str]'},
'auto_shutdown_profile': {'key': 'properties.autoShutdownProfile', 'type': 'AutoShutdownProfile'},
'connection_profile': {'key': 'properties.connectionProfile', 'type': 'ConnectionProfile'},
'virtual_machine_profile': {'key': 'properties.virtualMachineProfile', 'type': 'VirtualMachineProfile'},
'security_profile': {'key': 'properties.securityProfile', 'type': 'SecurityProfile'},
'roster_profile': {'key': 'properties.rosterProfile', 'type': 'RosterProfile'},
'lab_plan_id': {'key': 'properties.labPlanId', 'type': 'str'},
'title': {'key': 'properties.title', 'type': 'str'},
'description': {'key': 'properties.description', 'type': 'str'},
}
def __init__(
self,
*,
tags: Optional[List[str]] = None,
auto_shutdown_profile: Optional["AutoShutdownProfile"] = None,
connection_profile: Optional["ConnectionProfile"] = None,
virtual_machine_profile: Optional["VirtualMachineProfile"] = None,
security_profile: Optional["SecurityProfile"] = None,
roster_profile: Optional["RosterProfile"] = None,
lab_plan_id: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: list[str]
:keyword auto_shutdown_profile: The resource auto shutdown configuration for the lab. This
controls whether actions are taken on resources that are sitting idle.
:paramtype auto_shutdown_profile: ~azure.mgmt.labservices.models.AutoShutdownProfile
:keyword connection_profile: The connection profile for the lab. This controls settings such as
web access to lab resources or whether RDP or SSH ports are open.
:paramtype connection_profile: ~azure.mgmt.labservices.models.ConnectionProfile
:keyword virtual_machine_profile: The profile used for creating lab virtual machines.
:paramtype virtual_machine_profile: ~azure.mgmt.labservices.models.VirtualMachineProfile
:keyword security_profile: The lab security profile.
:paramtype security_profile: ~azure.mgmt.labservices.models.SecurityProfile
:keyword roster_profile: The lab user list management profile.
:paramtype roster_profile: ~azure.mgmt.labservices.models.RosterProfile
:keyword lab_plan_id: 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..
:paramtype lab_plan_id: str
:keyword title: The title of the lab.
:paramtype title: str
:keyword description: The description of the lab.
:paramtype description: str
"""
super(LabUpdate, self).__init__(tags=tags, **kwargs)
self.auto_shutdown_profile = auto_shutdown_profile
self.connection_profile = connection_profile
self.virtual_machine_profile = virtual_machine_profile
self.security_profile = security_profile
self.roster_profile = roster_profile
self.lab_plan_id = lab_plan_id
self.title = title
self.description = description
[docs]class ListUsagesResult(msrest.serialization.Model):
"""List of Core Usages.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The array page of Usages.
:vartype value: list[~azure.mgmt.labservices.models.Usage]
:ivar next_link: The link to get the next page of Usage result.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Usage]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(ListUsagesResult, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class Operation(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.
:ivar name: The name of the operation, as per Resource-Based Access Control (RBAC). Examples:
"Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action".
:vartype name: str
:ivar is_data_action: Whether the operation applies to data-plane. This is "true" for
data-plane operations and "false" for ARM/control-plane operations.
:vartype is_data_action: bool
:ivar display: Localized display information for this particular operation.
:vartype display: ~azure.mgmt.labservices.models.OperationDisplay
:ivar 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".
:vartype origin: str or ~azure.mgmt.labservices.models.Origin
:ivar action_type: Enum. Indicates the action type. "Internal" refers to actions that are for
internal only APIs. Possible values include: "Internal".
:vartype action_type: str or ~azure.mgmt.labservices.models.ActionType
"""
_validation = {
'name': {'readonly': True},
'is_data_action': {'readonly': True},
'origin': {'readonly': True},
'action_type': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'is_data_action': {'key': 'isDataAction', 'type': 'bool'},
'display': {'key': 'display', 'type': 'OperationDisplay'},
'origin': {'key': 'origin', 'type': 'str'},
'action_type': {'key': 'actionType', 'type': 'str'},
}
def __init__(
self,
*,
display: Optional["OperationDisplay"] = None,
**kwargs
):
"""
:keyword display: Localized display information for this particular operation.
:paramtype display: ~azure.mgmt.labservices.models.OperationDisplay
"""
super(Operation, self).__init__(**kwargs)
self.name = None
self.is_data_action = None
self.display = display
self.origin = None
self.action_type = None
[docs]class OperationDisplay(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.
:ivar provider: The localized friendly form of the resource provider name, e.g. "Microsoft
Monitoring Insights" or "Microsoft Compute".
:vartype provider: str
:ivar resource: The localized friendly name of the resource type related to this operation.
E.g. "Virtual Machines" or "Job Schedule Collections".
:vartype resource: str
:ivar operation: The concise, localized friendly name for the operation; suitable for
dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
:vartype operation: str
:ivar description: The short, localized friendly description of the operation; suitable for
tool tips and detailed views.
:vartype description: str
"""
_validation = {
'provider': {'readonly': True},
'resource': {'readonly': True},
'operation': {'readonly': True},
'description': {'readonly': True},
}
_attribute_map = {
'provider': {'key': 'provider', 'type': 'str'},
'resource': {'key': 'resource', 'type': 'str'},
'operation': {'key': 'operation', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(OperationDisplay, self).__init__(**kwargs)
self.provider = None
self.resource = None
self.operation = None
self.description = None
[docs]class OperationListResult(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.
:ivar value: List of operations supported by the resource provider.
:vartype value: list[~azure.mgmt.labservices.models.Operation]
:ivar next_link: URL to get the next set of operation list results (if there are any).
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Operation]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(OperationListResult, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class OperationResult(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar status: Required. The operation status. Possible values include: "NotStarted",
"InProgress", "Succeeded", "Failed", "Canceled".
:vartype status: str or ~azure.mgmt.labservices.models.OperationStatus
:ivar start_time: Start time.
:vartype start_time: ~datetime.datetime
:ivar end_time: End time.
:vartype end_time: ~datetime.datetime
:ivar percent_complete: Percent completion.
:vartype percent_complete: float
:ivar error: The error for a failure if the operation failed.
:vartype error: ~azure.mgmt.labservices.models.ErrorDetail
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'status': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'status': {'key': 'status', 'type': 'str'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
'end_time': {'key': 'endTime', 'type': 'iso-8601'},
'percent_complete': {'key': 'percentComplete', 'type': 'float'},
'error': {'key': 'error', 'type': 'ErrorDetail'},
}
def __init__(
self,
*,
status: Union[str, "OperationStatus"],
start_time: Optional[datetime.datetime] = None,
end_time: Optional[datetime.datetime] = None,
percent_complete: Optional[float] = None,
error: Optional["ErrorDetail"] = None,
**kwargs
):
"""
:keyword status: Required. The operation status. Possible values include: "NotStarted",
"InProgress", "Succeeded", "Failed", "Canceled".
:paramtype status: str or ~azure.mgmt.labservices.models.OperationStatus
:keyword start_time: Start time.
:paramtype start_time: ~datetime.datetime
:keyword end_time: End time.
:paramtype end_time: ~datetime.datetime
:keyword percent_complete: Percent completion.
:paramtype percent_complete: float
:keyword error: The error for a failure if the operation failed.
:paramtype error: ~azure.mgmt.labservices.models.ErrorDetail
"""
super(OperationResult, self).__init__(**kwargs)
self.id = None
self.name = None
self.status = status
self.start_time = start_time
self.end_time = end_time
self.percent_complete = percent_complete
self.error = error
[docs]class PagedImages(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.
:ivar value: The array page of virtual machine images.
:vartype value: list[~azure.mgmt.labservices.models.Image]
:ivar next_link: The link to get the next page of image results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Image]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedImages, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PagedLabPlans(msrest.serialization.Model):
"""Paged list of lab plans.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The array page of lab plans.
:vartype value: list[~azure.mgmt.labservices.models.LabPlan]
:ivar next_link: The link to get the next page of lab plan results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[LabPlan]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedLabPlans, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PagedLabs(msrest.serialization.Model):
"""Paged list of labs.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The array page of lab results.
:vartype value: list[~azure.mgmt.labservices.models.Lab]
:ivar next_link: The link to get the next page of image results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Lab]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedLabs, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PagedLabServicesSkus(msrest.serialization.Model):
"""Paged list of lab services skus.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The array page of sku results.
:vartype value: list[~azure.mgmt.labservices.models.LabServicesSku]
:ivar next_link: The link to get the next page of sku results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[LabServicesSku]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedLabServicesSkus, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PagedSchedules(msrest.serialization.Model):
"""Paged list of schedules.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The array page of schedule results.
:vartype value: list[~azure.mgmt.labservices.models.Schedule]
:ivar next_link: The link to get the next page of schedule results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Schedule]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedSchedules, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PagedUsers(msrest.serialization.Model):
"""Paged list of users.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The array page of user results.
:vartype value: list[~azure.mgmt.labservices.models.User]
:ivar next_link: The link to get the next page of image results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[User]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedUsers, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PagedVirtualMachines(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.
:ivar value: The array page of virtual machine results.
:vartype value: list[~azure.mgmt.labservices.models.VirtualMachine]
:ivar next_link: The link to get the next page of virtual machine results.
:vartype next_link: str
"""
_validation = {
'value': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachine]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PagedVirtualMachines, self).__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class RecurrencePattern(msrest.serialization.Model):
"""Recurrence pattern of a lab schedule.
All required parameters must be populated in order to send to Azure.
:ivar frequency: Required. The frequency of the recurrence. Possible values include: "Daily",
"Weekly".
:vartype frequency: str or ~azure.mgmt.labservices.models.RecurrenceFrequency
:ivar week_days: The week days the schedule runs. Used for when the Frequency is set to Weekly.
:vartype week_days: list[str or ~azure.mgmt.labservices.models.WeekDay]
:ivar interval: 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.
:vartype interval: int
:ivar expiration_date: Required. When the recurrence will expire. This date is inclusive.
:vartype expiration_date: ~datetime.date
"""
_validation = {
'frequency': {'required': True},
'interval': {'maximum': 365, 'minimum': 1},
'expiration_date': {'required': True},
}
_attribute_map = {
'frequency': {'key': 'frequency', 'type': 'str'},
'week_days': {'key': 'weekDays', 'type': '[str]'},
'interval': {'key': 'interval', 'type': 'int'},
'expiration_date': {'key': 'expirationDate', 'type': 'date'},
}
def __init__(
self,
*,
frequency: Union[str, "RecurrenceFrequency"],
expiration_date: datetime.date,
week_days: Optional[List[Union[str, "WeekDay"]]] = None,
interval: Optional[int] = None,
**kwargs
):
"""
:keyword frequency: Required. The frequency of the recurrence. Possible values include:
"Daily", "Weekly".
:paramtype frequency: str or ~azure.mgmt.labservices.models.RecurrenceFrequency
:keyword week_days: The week days the schedule runs. Used for when the Frequency is set to
Weekly.
:paramtype week_days: list[str or ~azure.mgmt.labservices.models.WeekDay]
:keyword interval: 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.
:paramtype interval: int
:keyword expiration_date: Required. When the recurrence will expire. This date is inclusive.
:paramtype expiration_date: ~datetime.date
"""
super(RecurrencePattern, self).__init__(**kwargs)
self.frequency = frequency
self.week_days = week_days
self.interval = interval
self.expiration_date = expiration_date
[docs]class ResetPasswordBody(msrest.serialization.Model):
"""Body of a reset password request.
All required parameters must be populated in order to send to Azure.
:ivar username: Required. The user whose password is being reset.
:vartype username: str
:ivar password: Required. The password.
:vartype password: str
"""
_validation = {
'username': {'required': True},
'password': {'required': True},
}
_attribute_map = {
'username': {'key': 'username', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
}
def __init__(
self,
*,
username: str,
password: str,
**kwargs
):
"""
:keyword username: Required. The user whose password is being reset.
:paramtype username: str
:keyword password: Required. The password.
:paramtype password: str
"""
super(ResetPasswordBody, self).__init__(**kwargs)
self.username = username
self.password = password
[docs]class RosterProfile(msrest.serialization.Model):
"""The lab user list management profile.
:ivar active_directory_group_id: The AAD group ID which this lab roster is populated from.
Having this set enables AAD sync mode.
:vartype active_directory_group_id: str
:ivar lti_context_id: The unique context identifier for the lab in the lms.
:vartype lti_context_id: str
:ivar lms_instance: The base URI identifying the lms instance.
:vartype lms_instance: str
:ivar lti_client_id: The unique id of the azure lab services tool in the lms.
:vartype lti_client_id: str
:ivar lti_roster_endpoint: The uri of the names and roles service endpoint on the lms for the
class attached to this lab.
:vartype lti_roster_endpoint: str
"""
_attribute_map = {
'active_directory_group_id': {'key': 'activeDirectoryGroupId', 'type': 'str'},
'lti_context_id': {'key': 'ltiContextId', 'type': 'str'},
'lms_instance': {'key': 'lmsInstance', 'type': 'str'},
'lti_client_id': {'key': 'ltiClientId', 'type': 'str'},
'lti_roster_endpoint': {'key': 'ltiRosterEndpoint', 'type': 'str'},
}
def __init__(
self,
*,
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
):
"""
:keyword active_directory_group_id: The AAD group ID which this lab roster is populated from.
Having this set enables AAD sync mode.
:paramtype active_directory_group_id: str
:keyword lti_context_id: The unique context identifier for the lab in the lms.
:paramtype lti_context_id: str
:keyword lms_instance: The base URI identifying the lms instance.
:paramtype lms_instance: str
:keyword lti_client_id: The unique id of the azure lab services tool in the lms.
:paramtype lti_client_id: str
:keyword lti_roster_endpoint: The uri of the names and roles service endpoint on the lms for
the class attached to this lab.
:paramtype lti_roster_endpoint: str
"""
super(RosterProfile, self).__init__(**kwargs)
self.active_directory_group_id = active_directory_group_id
self.lti_context_id = lti_context_id
self.lms_instance = lms_instance
self.lti_client_id = lti_client_id
self.lti_roster_endpoint = lti_roster_endpoint
[docs]class SaveImageBody(msrest.serialization.Model):
"""Body for the save image POST.
:ivar name: The name for the image we create.
:vartype name: str
:ivar lab_virtual_machine_id: The ID of the lab virtual machine you want to save an image from.
:vartype lab_virtual_machine_id: str
"""
_validation = {
'lab_virtual_machine_id': {'max_length': 2000, 'min_length': 3},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'lab_virtual_machine_id': {'key': 'labVirtualMachineId', 'type': 'str'},
}
def __init__(
self,
*,
name: Optional[str] = None,
lab_virtual_machine_id: Optional[str] = None,
**kwargs
):
"""
:keyword name: The name for the image we create.
:paramtype name: str
:keyword lab_virtual_machine_id: The ID of the lab virtual machine you want to save an image
from.
:paramtype lab_virtual_machine_id: str
"""
super(SaveImageBody, self).__init__(**kwargs)
self.name = name
self.lab_virtual_machine_id = lab_virtual_machine_id
[docs]class Schedule(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Metadata pertaining to creation and last modification of the schedule.
:vartype system_data: ~azure.mgmt.labservices.models.SystemData
:ivar start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype start_at: ~datetime.datetime
:ivar stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype stop_at: ~datetime.datetime
:ivar recurrence_pattern: The recurrence pattern of the scheduled actions.
:vartype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:ivar time_zone_id: The IANA timezone id for the schedule.
:vartype time_zone_id: str
:ivar notes: Notes for this schedule.
:vartype notes: str
:ivar provisioning_state: Current provisioning state of the schedule. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'system_data': {'readonly': True},
'time_zone_id': {'max_length': 50, 'min_length': 0},
'notes': {'max_length': 1000, 'min_length': 0},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'system_data': {'key': 'systemData', 'type': 'SystemData'},
'start_at': {'key': 'properties.startAt', 'type': 'iso-8601'},
'stop_at': {'key': 'properties.stopAt', 'type': 'iso-8601'},
'recurrence_pattern': {'key': 'properties.recurrencePattern', 'type': 'RecurrencePattern'},
'time_zone_id': {'key': 'properties.timeZoneId', 'type': 'str'},
'notes': {'key': 'properties.notes', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
start_at: Optional[datetime.datetime] = None,
stop_at: Optional[datetime.datetime] = None,
recurrence_pattern: Optional["RecurrencePattern"] = None,
time_zone_id: Optional[str] = None,
notes: Optional[str] = None,
**kwargs
):
"""
:keyword start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype start_at: ~datetime.datetime
:keyword stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype stop_at: ~datetime.datetime
:keyword recurrence_pattern: The recurrence pattern of the scheduled actions.
:paramtype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:keyword time_zone_id: The IANA timezone id for the schedule.
:paramtype time_zone_id: str
:keyword notes: Notes for this schedule.
:paramtype notes: str
"""
super(Schedule, self).__init__(**kwargs)
self.system_data = None
self.start_at = start_at
self.stop_at = stop_at
self.recurrence_pattern = recurrence_pattern
self.time_zone_id = time_zone_id
self.notes = notes
self.provisioning_state = None
[docs]class ScheduleUpdateProperties(msrest.serialization.Model):
"""Schedule resource properties used for updates.
:ivar start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype start_at: ~datetime.datetime
:ivar stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype stop_at: ~datetime.datetime
:ivar recurrence_pattern: The recurrence pattern of the scheduled actions.
:vartype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:ivar time_zone_id: The IANA timezone id for the schedule.
:vartype time_zone_id: str
:ivar notes: Notes for this schedule.
:vartype notes: str
"""
_validation = {
'time_zone_id': {'max_length': 50, 'min_length': 0},
'notes': {'max_length': 1000, 'min_length': 0},
}
_attribute_map = {
'start_at': {'key': 'startAt', 'type': 'iso-8601'},
'stop_at': {'key': 'stopAt', 'type': 'iso-8601'},
'recurrence_pattern': {'key': 'recurrencePattern', 'type': 'RecurrencePattern'},
'time_zone_id': {'key': 'timeZoneId', 'type': 'str'},
'notes': {'key': 'notes', 'type': 'str'},
}
def __init__(
self,
*,
start_at: Optional[datetime.datetime] = None,
stop_at: Optional[datetime.datetime] = None,
recurrence_pattern: Optional["RecurrencePattern"] = None,
time_zone_id: Optional[str] = None,
notes: Optional[str] = None,
**kwargs
):
"""
:keyword start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype start_at: ~datetime.datetime
:keyword stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype stop_at: ~datetime.datetime
:keyword recurrence_pattern: The recurrence pattern of the scheduled actions.
:paramtype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:keyword time_zone_id: The IANA timezone id for the schedule.
:paramtype time_zone_id: str
:keyword notes: Notes for this schedule.
:paramtype notes: str
"""
super(ScheduleUpdateProperties, self).__init__(**kwargs)
self.start_at = start_at
self.stop_at = stop_at
self.recurrence_pattern = recurrence_pattern
self.time_zone_id = time_zone_id
self.notes = notes
[docs]class ScheduleProperties(ScheduleUpdateProperties):
"""Schedule resource properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype start_at: ~datetime.datetime
:ivar stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype stop_at: ~datetime.datetime
:ivar recurrence_pattern: The recurrence pattern of the scheduled actions.
:vartype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:ivar time_zone_id: The IANA timezone id for the schedule.
:vartype time_zone_id: str
:ivar notes: Notes for this schedule.
:vartype notes: str
:ivar provisioning_state: Current provisioning state of the schedule. Possible values include:
"Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
"""
_validation = {
'time_zone_id': {'max_length': 50, 'min_length': 0},
'notes': {'max_length': 1000, 'min_length': 0},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'start_at': {'key': 'startAt', 'type': 'iso-8601'},
'stop_at': {'key': 'stopAt', 'type': 'iso-8601'},
'recurrence_pattern': {'key': 'recurrencePattern', 'type': 'RecurrencePattern'},
'time_zone_id': {'key': 'timeZoneId', 'type': 'str'},
'notes': {'key': 'notes', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
start_at: Optional[datetime.datetime] = None,
stop_at: Optional[datetime.datetime] = None,
recurrence_pattern: Optional["RecurrencePattern"] = None,
time_zone_id: Optional[str] = None,
notes: Optional[str] = None,
**kwargs
):
"""
:keyword start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype start_at: ~datetime.datetime
:keyword stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype stop_at: ~datetime.datetime
:keyword recurrence_pattern: The recurrence pattern of the scheduled actions.
:paramtype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:keyword time_zone_id: The IANA timezone id for the schedule.
:paramtype time_zone_id: str
:keyword notes: Notes for this schedule.
:paramtype notes: str
"""
super(ScheduleProperties, self).__init__(start_at=start_at, stop_at=stop_at, recurrence_pattern=recurrence_pattern, time_zone_id=time_zone_id, notes=notes, **kwargs)
self.provisioning_state = None
[docs]class ScheduleUpdate(msrest.serialization.Model):
"""Schedule for automatically turning virtual machines in a lab on and off at specified times. Used for updates.
:ivar start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype start_at: ~datetime.datetime
:ivar stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:vartype stop_at: ~datetime.datetime
:ivar recurrence_pattern: The recurrence pattern of the scheduled actions.
:vartype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:ivar time_zone_id: The IANA timezone id for the schedule.
:vartype time_zone_id: str
:ivar notes: Notes for this schedule.
:vartype notes: str
"""
_validation = {
'time_zone_id': {'max_length': 50, 'min_length': 0},
'notes': {'max_length': 1000, 'min_length': 0},
}
_attribute_map = {
'start_at': {'key': 'properties.startAt', 'type': 'iso-8601'},
'stop_at': {'key': 'properties.stopAt', 'type': 'iso-8601'},
'recurrence_pattern': {'key': 'properties.recurrencePattern', 'type': 'RecurrencePattern'},
'time_zone_id': {'key': 'properties.timeZoneId', 'type': 'str'},
'notes': {'key': 'properties.notes', 'type': 'str'},
}
def __init__(
self,
*,
start_at: Optional[datetime.datetime] = None,
stop_at: Optional[datetime.datetime] = None,
recurrence_pattern: Optional["RecurrencePattern"] = None,
time_zone_id: Optional[str] = None,
notes: Optional[str] = None,
**kwargs
):
"""
:keyword start_at: When lab user virtual machines will be started. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype start_at: ~datetime.datetime
:keyword stop_at: When lab user virtual machines will be stopped. Timestamp offsets will be
ignored and timeZoneId is used instead.
:paramtype stop_at: ~datetime.datetime
:keyword recurrence_pattern: The recurrence pattern of the scheduled actions.
:paramtype recurrence_pattern: ~azure.mgmt.labservices.models.RecurrencePattern
:keyword time_zone_id: The IANA timezone id for the schedule.
:paramtype time_zone_id: str
:keyword notes: Notes for this schedule.
:paramtype notes: str
"""
super(ScheduleUpdate, self).__init__(**kwargs)
self.start_at = start_at
self.stop_at = stop_at
self.recurrence_pattern = recurrence_pattern
self.time_zone_id = time_zone_id
self.notes = notes
[docs]class SecurityProfile(msrest.serialization.Model):
"""The lab security profile.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar registration_code: The registration code for the lab.
:vartype registration_code: str
:ivar open_access: Whether any user or only specified users can register to a lab. Possible
values include: "Enabled", "Disabled".
:vartype open_access: str or ~azure.mgmt.labservices.models.EnableState
"""
_validation = {
'registration_code': {'readonly': True},
}
_attribute_map = {
'registration_code': {'key': 'registrationCode', 'type': 'str'},
'open_access': {'key': 'openAccess', 'type': 'str'},
}
def __init__(
self,
*,
open_access: Optional[Union[str, "EnableState"]] = None,
**kwargs
):
"""
:keyword open_access: Whether any user or only specified users can register to a lab. Possible
values include: "Enabled", "Disabled".
:paramtype open_access: str or ~azure.mgmt.labservices.models.EnableState
"""
super(SecurityProfile, self).__init__(**kwargs)
self.registration_code = None
self.open_access = open_access
[docs]class Sku(msrest.serialization.Model):
"""The resource model definition representing SKU.
All required parameters must be populated in order to send to Azure.
:ivar name: Required. The name of the SKU. Ex - P3. It is typically a letter+number code.
:vartype name: str
:ivar tier: 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".
:vartype tier: str or ~azure.mgmt.labservices.models.SkuTier
:ivar size: The SKU size. When the name field is the combination of tier and some other value,
this would be the standalone code.
:vartype size: str
:ivar family: If the service has different generations of hardware, for the same SKU, then that
can be captured here.
:vartype family: str
:ivar capacity: 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.
:vartype capacity: int
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
'size': {'key': 'size', 'type': 'str'},
'family': {'key': 'family', 'type': 'str'},
'capacity': {'key': 'capacity', 'type': 'int'},
}
def __init__(
self,
*,
name: str,
tier: Optional[Union[str, "SkuTier"]] = None,
size: Optional[str] = None,
family: Optional[str] = None,
capacity: Optional[int] = None,
**kwargs
):
"""
:keyword name: Required. The name of the SKU. Ex - P3. It is typically a letter+number code.
:paramtype name: str
:keyword tier: 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".
:paramtype tier: str or ~azure.mgmt.labservices.models.SkuTier
:keyword size: The SKU size. When the name field is the combination of tier and some other
value, this would be the standalone code.
:paramtype size: str
:keyword family: If the service has different generations of hardware, for the same SKU, then
that can be captured here.
:paramtype family: str
:keyword capacity: 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.
:paramtype capacity: int
"""
super(Sku, self).__init__(**kwargs)
self.name = name
self.tier = tier
self.size = size
self.family = family
self.capacity = capacity
[docs]class SupportInfo(msrest.serialization.Model):
"""Support contact information and instructions.
:ivar url: Support web address.
:vartype url: str
:ivar email: Support contact email address.
:vartype email: str
:ivar phone: Support contact phone number.
:vartype phone: str
:ivar instructions: Support instructions.
:vartype instructions: str
"""
_validation = {
'url': {'max_length': 2000, 'min_length': 3},
'email': {'max_length': 254, 'min_length': 6},
'phone': {'max_length': 31, 'min_length': 1},
}
_attribute_map = {
'url': {'key': 'url', 'type': 'str'},
'email': {'key': 'email', 'type': 'str'},
'phone': {'key': 'phone', 'type': 'str'},
'instructions': {'key': 'instructions', 'type': 'str'},
}
def __init__(
self,
*,
url: Optional[str] = None,
email: Optional[str] = None,
phone: Optional[str] = None,
instructions: Optional[str] = None,
**kwargs
):
"""
:keyword url: Support web address.
:paramtype url: str
:keyword email: Support contact email address.
:paramtype email: str
:keyword phone: Support contact phone number.
:paramtype phone: str
:keyword instructions: Support instructions.
:paramtype instructions: str
"""
super(SupportInfo, self).__init__(**kwargs)
self.url = url
self.email = email
self.phone = phone
self.instructions = instructions
[docs]class SystemData(msrest.serialization.Model):
"""Metadata pertaining to creation and last modification of the resource.
:ivar created_by: The identity that created the resource.
:vartype created_by: str
:ivar created_by_type: The type of identity that created the resource. Possible values include:
"User", "Application", "ManagedIdentity", "Key".
:vartype created_by_type: str or ~azure.mgmt.labservices.models.CreatedByType
:ivar created_at: The timestamp of resource creation (UTC).
:vartype created_at: ~datetime.datetime
:ivar last_modified_by: The identity that last modified the resource.
:vartype last_modified_by: str
:ivar last_modified_by_type: The type of identity that last modified the resource. Possible
values include: "User", "Application", "ManagedIdentity", "Key".
:vartype last_modified_by_type: str or ~azure.mgmt.labservices.models.CreatedByType
:ivar last_modified_at: The timestamp of resource last modification (UTC).
:vartype last_modified_at: ~datetime.datetime
"""
_attribute_map = {
'created_by': {'key': 'createdBy', 'type': 'str'},
'created_by_type': {'key': 'createdByType', 'type': 'str'},
'created_at': {'key': 'createdAt', 'type': 'iso-8601'},
'last_modified_by': {'key': 'lastModifiedBy', 'type': 'str'},
'last_modified_by_type': {'key': 'lastModifiedByType', 'type': 'str'},
'last_modified_at': {'key': 'lastModifiedAt', 'type': 'iso-8601'},
}
def __init__(
self,
*,
created_by: Optional[str] = None,
created_by_type: Optional[Union[str, "CreatedByType"]] = None,
created_at: Optional[datetime.datetime] = None,
last_modified_by: Optional[str] = None,
last_modified_by_type: Optional[Union[str, "CreatedByType"]] = None,
last_modified_at: Optional[datetime.datetime] = None,
**kwargs
):
"""
:keyword created_by: The identity that created the resource.
:paramtype created_by: str
:keyword created_by_type: The type of identity that created the resource. Possible values
include: "User", "Application", "ManagedIdentity", "Key".
:paramtype created_by_type: str or ~azure.mgmt.labservices.models.CreatedByType
:keyword created_at: The timestamp of resource creation (UTC).
:paramtype created_at: ~datetime.datetime
:keyword last_modified_by: The identity that last modified the resource.
:paramtype last_modified_by: str
:keyword last_modified_by_type: The type of identity that last modified the resource. Possible
values include: "User", "Application", "ManagedIdentity", "Key".
:paramtype last_modified_by_type: str or ~azure.mgmt.labservices.models.CreatedByType
:keyword last_modified_at: The timestamp of resource last modification (UTC).
:paramtype last_modified_at: ~datetime.datetime
"""
super(SystemData, self).__init__(**kwargs)
self.created_by = created_by
self.created_by_type = created_by_type
self.created_at = created_at
self.last_modified_by = last_modified_by
self.last_modified_by_type = last_modified_by_type
self.last_modified_at = last_modified_at
[docs]class Usage(msrest.serialization.Model):
"""The core usage details.
:ivar current_value: The current usage.
:vartype current_value: long
:ivar limit: The limit integer.
:vartype limit: long
:ivar unit: The unit details. Possible values include: "Count".
:vartype unit: str or ~azure.mgmt.labservices.models.UsageUnit
:ivar name: The name.
:vartype name: ~azure.mgmt.labservices.models.UsageName
:ivar id: The fully qualified arm resource id.
:vartype id: str
"""
_attribute_map = {
'current_value': {'key': 'currentValue', 'type': 'long'},
'limit': {'key': 'limit', 'type': 'long'},
'unit': {'key': 'unit', 'type': 'str'},
'name': {'key': 'name', 'type': 'UsageName'},
'id': {'key': 'id', 'type': 'str'},
}
def __init__(
self,
*,
current_value: Optional[int] = None,
limit: Optional[int] = None,
unit: Optional[Union[str, "UsageUnit"]] = None,
name: Optional["UsageName"] = None,
id: Optional[str] = None,
**kwargs
):
"""
:keyword current_value: The current usage.
:paramtype current_value: long
:keyword limit: The limit integer.
:paramtype limit: long
:keyword unit: The unit details. Possible values include: "Count".
:paramtype unit: str or ~azure.mgmt.labservices.models.UsageUnit
:keyword name: The name.
:paramtype name: ~azure.mgmt.labservices.models.UsageName
:keyword id: The fully qualified arm resource id.
:paramtype id: str
"""
super(Usage, self).__init__(**kwargs)
self.current_value = current_value
self.limit = limit
self.unit = unit
self.name = name
self.id = id
[docs]class UsageName(msrest.serialization.Model):
"""The Usage Names.
:ivar localized_value: The localized name of the resource.
:vartype localized_value: str
:ivar value: The name of the resource.
:vartype value: str
"""
_attribute_map = {
'localized_value': {'key': 'localizedValue', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(
self,
*,
localized_value: Optional[str] = None,
value: Optional[str] = None,
**kwargs
):
"""
:keyword localized_value: The localized name of the resource.
:paramtype localized_value: str
:keyword value: The name of the resource.
:paramtype value: str
"""
super(UsageName, self).__init__(**kwargs)
self.localized_value = localized_value
self.value = value
[docs]class User(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Metadata pertaining to creation and last modification of the user resource.
:vartype system_data: ~azure.mgmt.labservices.models.SystemData
:ivar additional_usage_quota: The amount of usage quota time the user gets in addition to the
lab usage quota.
:vartype additional_usage_quota: ~datetime.timedelta
:ivar provisioning_state: Current provisioning state of the user resource. Possible values
include: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar display_name: Display name of the user, for example user's full name.
:vartype display_name: str
:ivar email: Required. Email address of the user.
:vartype email: str
:ivar registration_state: State of the user's registration within the lab. Possible values
include: "Registered", "NotRegistered".
:vartype registration_state: str or ~azure.mgmt.labservices.models.RegistrationState
:ivar invitation_state: State of the invitation message for the user. Possible values include:
"NotSent", "Sending", "Sent", "Failed".
:vartype invitation_state: str or ~azure.mgmt.labservices.models.InvitationState
:ivar invitation_sent: Date and time when the invitation message was sent to the user.
:vartype invitation_sent: ~datetime.datetime
:ivar total_usage: How long the user has used their virtual machines in this lab.
:vartype total_usage: ~datetime.timedelta
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'system_data': {'readonly': True},
'provisioning_state': {'readonly': True},
'display_name': {'readonly': True},
'email': {'required': True, 'max_length': 254, 'min_length': 6},
'registration_state': {'readonly': True},
'invitation_state': {'readonly': True},
'invitation_sent': {'readonly': True},
'total_usage': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'system_data': {'key': 'systemData', 'type': 'SystemData'},
'additional_usage_quota': {'key': 'properties.additionalUsageQuota', 'type': 'duration'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'display_name': {'key': 'properties.displayName', 'type': 'str'},
'email': {'key': 'properties.email', 'type': 'str'},
'registration_state': {'key': 'properties.registrationState', 'type': 'str'},
'invitation_state': {'key': 'properties.invitationState', 'type': 'str'},
'invitation_sent': {'key': 'properties.invitationSent', 'type': 'iso-8601'},
'total_usage': {'key': 'properties.totalUsage', 'type': 'duration'},
}
def __init__(
self,
*,
email: str,
additional_usage_quota: Optional[datetime.timedelta] = None,
**kwargs
):
"""
:keyword additional_usage_quota: The amount of usage quota time the user gets in addition to
the lab usage quota.
:paramtype additional_usage_quota: ~datetime.timedelta
:keyword email: Required. Email address of the user.
:paramtype email: str
"""
super(User, self).__init__(**kwargs)
self.system_data = None
self.additional_usage_quota = additional_usage_quota
self.provisioning_state = None
self.display_name = None
self.email = email
self.registration_state = None
self.invitation_state = None
self.invitation_sent = None
self.total_usage = None
[docs]class UserUpdateProperties(msrest.serialization.Model):
"""User resource properties used for updates.
:ivar additional_usage_quota: The amount of usage quota time the user gets in addition to the
lab usage quota.
:vartype additional_usage_quota: ~datetime.timedelta
"""
_attribute_map = {
'additional_usage_quota': {'key': 'additionalUsageQuota', 'type': 'duration'},
}
def __init__(
self,
*,
additional_usage_quota: Optional[datetime.timedelta] = None,
**kwargs
):
"""
:keyword additional_usage_quota: The amount of usage quota time the user gets in addition to
the lab usage quota.
:paramtype additional_usage_quota: ~datetime.timedelta
"""
super(UserUpdateProperties, self).__init__(**kwargs)
self.additional_usage_quota = additional_usage_quota
[docs]class UserProperties(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.
:ivar additional_usage_quota: The amount of usage quota time the user gets in addition to the
lab usage quota.
:vartype additional_usage_quota: ~datetime.timedelta
:ivar provisioning_state: Current provisioning state of the user resource. Possible values
include: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar display_name: Display name of the user, for example user's full name.
:vartype display_name: str
:ivar email: Required. Email address of the user.
:vartype email: str
:ivar registration_state: State of the user's registration within the lab. Possible values
include: "Registered", "NotRegistered".
:vartype registration_state: str or ~azure.mgmt.labservices.models.RegistrationState
:ivar invitation_state: State of the invitation message for the user. Possible values include:
"NotSent", "Sending", "Sent", "Failed".
:vartype invitation_state: str or ~azure.mgmt.labservices.models.InvitationState
:ivar invitation_sent: Date and time when the invitation message was sent to the user.
:vartype invitation_sent: ~datetime.datetime
:ivar total_usage: How long the user has used their virtual machines in this lab.
:vartype total_usage: ~datetime.timedelta
"""
_validation = {
'provisioning_state': {'readonly': True},
'display_name': {'readonly': True},
'email': {'required': True, 'max_length': 254, 'min_length': 6},
'registration_state': {'readonly': True},
'invitation_state': {'readonly': True},
'invitation_sent': {'readonly': True},
'total_usage': {'readonly': True},
}
_attribute_map = {
'additional_usage_quota': {'key': 'additionalUsageQuota', 'type': 'duration'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'display_name': {'key': 'displayName', 'type': 'str'},
'email': {'key': 'email', 'type': 'str'},
'registration_state': {'key': 'registrationState', 'type': 'str'},
'invitation_state': {'key': 'invitationState', 'type': 'str'},
'invitation_sent': {'key': 'invitationSent', 'type': 'iso-8601'},
'total_usage': {'key': 'totalUsage', 'type': 'duration'},
}
def __init__(
self,
*,
email: str,
additional_usage_quota: Optional[datetime.timedelta] = None,
**kwargs
):
"""
:keyword additional_usage_quota: The amount of usage quota time the user gets in addition to
the lab usage quota.
:paramtype additional_usage_quota: ~datetime.timedelta
:keyword email: Required. Email address of the user.
:paramtype email: str
"""
super(UserProperties, self).__init__(additional_usage_quota=additional_usage_quota, **kwargs)
self.provisioning_state = None
self.display_name = None
self.email = email
self.registration_state = None
self.invitation_state = None
self.invitation_sent = None
self.total_usage = None
[docs]class UserUpdate(msrest.serialization.Model):
"""User of a lab that can register for and use virtual machines within the lab. Used for updates.
:ivar additional_usage_quota: The amount of usage quota time the user gets in addition to the
lab usage quota.
:vartype additional_usage_quota: ~datetime.timedelta
"""
_attribute_map = {
'additional_usage_quota': {'key': 'properties.additionalUsageQuota', 'type': 'duration'},
}
def __init__(
self,
*,
additional_usage_quota: Optional[datetime.timedelta] = None,
**kwargs
):
"""
:keyword additional_usage_quota: The amount of usage quota time the user gets in addition to
the lab usage quota.
:paramtype additional_usage_quota: ~datetime.timedelta
"""
super(UserUpdate, self).__init__(**kwargs)
self.additional_usage_quota = additional_usage_quota
[docs]class VirtualMachine(ProxyResource):
"""A lab virtual machine resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: System data of the Lab virtual machine.
:vartype system_data: ~azure.mgmt.labservices.models.SystemData
:ivar provisioning_state: Current provisioning state of the virtual machine. Possible values
include: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Locked".
:vartype provisioning_state: str or ~azure.mgmt.labservices.models.ProvisioningState
:ivar state: The current state of the virtual machine. Possible values include: "Stopped",
"Starting", "Running", "Stopping", "ResettingPassword", "Reimaging", "Redeploying".
:vartype state: str or ~azure.mgmt.labservices.models.VirtualMachineState
:ivar connection_profile: Profile for information about connecting to the virtual machine.
:vartype connection_profile: ~azure.mgmt.labservices.models.VirtualMachineConnectionProfile
:ivar claimed_by_user_id: The lab user ID (not the PUID!) of who claimed the virtual machine.
:vartype claimed_by_user_id: str
:ivar vm_type: The type of this VM resource. Possible values include: "User", "Template".
:vartype vm_type: str or ~azure.mgmt.labservices.models.VirtualMachineType
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'system_data': {'readonly': True},
'provisioning_state': {'readonly': True},
'state': {'readonly': True},
'connection_profile': {'readonly': True},
'claimed_by_user_id': {'readonly': True},
'vm_type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'system_data': {'key': 'systemData', 'type': 'SystemData'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'state': {'key': 'properties.state', 'type': 'str'},
'connection_profile': {'key': 'properties.connectionProfile', 'type': 'VirtualMachineConnectionProfile'},
'claimed_by_user_id': {'key': 'properties.claimedByUserId', 'type': 'str'},
'vm_type': {'key': 'properties.vmType', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(VirtualMachine, self).__init__(**kwargs)
self.system_data = None
self.provisioning_state = None
self.state = None
self.connection_profile = None
self.claimed_by_user_id = None
self.vm_type = None
[docs]class VirtualMachineAdditionalCapabilities(msrest.serialization.Model):
"""The additional capabilities for a lab VM.
:ivar install_gpu_drivers: Flag to pre-install dedicated GPU drivers. Possible values include:
"Enabled", "Disabled".
:vartype install_gpu_drivers: str or ~azure.mgmt.labservices.models.EnableState
"""
_attribute_map = {
'install_gpu_drivers': {'key': 'installGpuDrivers', 'type': 'str'},
}
def __init__(
self,
*,
install_gpu_drivers: Optional[Union[str, "EnableState"]] = None,
**kwargs
):
"""
:keyword install_gpu_drivers: Flag to pre-install dedicated GPU drivers. Possible values
include: "Enabled", "Disabled".
:paramtype install_gpu_drivers: str or ~azure.mgmt.labservices.models.EnableState
"""
super(VirtualMachineAdditionalCapabilities, self).__init__(**kwargs)
self.install_gpu_drivers = install_gpu_drivers
[docs]class VirtualMachineConnectionProfile(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.
:ivar private_ip_address: The private IP address of the virtual machine.
:vartype private_ip_address: str
:ivar ssh_authority: Port and host name separated by semicolon for connecting via SSH protocol
to the virtual machine.
:vartype ssh_authority: str
:ivar ssh_in_browser_url: URL for connecting via SSH protocol to the virtual machine in
browser.
:vartype ssh_in_browser_url: str
:ivar rdp_authority: Port and host name separated by semicolon for connecting via RDP protocol
to the virtual machine.
:vartype rdp_authority: str
:ivar rdp_in_browser_url: URL for connecting via RDP protocol to the virtual machine in
browser.
:vartype rdp_in_browser_url: str
:ivar admin_username: The username used to log on to the virtual machine as admin.
:vartype admin_username: str
:ivar non_admin_username: The username used to log on to the virtual machine as non-admin, if
one exists.
:vartype non_admin_username: str
"""
_validation = {
'private_ip_address': {'readonly': True},
'ssh_authority': {'readonly': True},
'ssh_in_browser_url': {'readonly': True, 'max_length': 2000, 'min_length': 3},
'rdp_authority': {'readonly': True},
'rdp_in_browser_url': {'readonly': True, 'max_length': 2000, 'min_length': 3},
'admin_username': {'readonly': True},
'non_admin_username': {'readonly': True},
}
_attribute_map = {
'private_ip_address': {'key': 'privateIpAddress', 'type': 'str'},
'ssh_authority': {'key': 'sshAuthority', 'type': 'str'},
'ssh_in_browser_url': {'key': 'sshInBrowserUrl', 'type': 'str'},
'rdp_authority': {'key': 'rdpAuthority', 'type': 'str'},
'rdp_in_browser_url': {'key': 'rdpInBrowserUrl', 'type': 'str'},
'admin_username': {'key': 'adminUsername', 'type': 'str'},
'non_admin_username': {'key': 'nonAdminUsername', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(VirtualMachineConnectionProfile, self).__init__(**kwargs)
self.private_ip_address = None
self.ssh_authority = None
self.ssh_in_browser_url = None
self.rdp_authority = None
self.rdp_in_browser_url = None
self.admin_username = None
self.non_admin_username = None
[docs]class VirtualMachineProfile(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.
:ivar create_option: Required. Indicates what lab virtual machines are created from. Possible
values include: "Image", "TemplateVM".
:vartype create_option: str or ~azure.mgmt.labservices.models.CreateOption
:ivar image_reference: Required. The image configuration for lab virtual machines.
:vartype image_reference: ~azure.mgmt.labservices.models.ImageReference
:ivar os_type: The OS type of the image. Possible values include: "Windows", "Linux".
:vartype os_type: str or ~azure.mgmt.labservices.models.OsType
:ivar sku: Required. The SKU for the lab. Defines the type of virtual machines used in the lab.
:vartype sku: ~azure.mgmt.labservices.models.Sku
:ivar additional_capabilities: Additional VM capabilities.
:vartype additional_capabilities:
~azure.mgmt.labservices.models.VirtualMachineAdditionalCapabilities
:ivar usage_quota: Required. The initial quota alloted to each lab user. Must be a time span
between 0 and 9999 hours.
:vartype usage_quota: ~datetime.timedelta
:ivar use_shared_password: Enabling this option will use the same password for all user VMs.
Possible values include: "Enabled", "Disabled".
:vartype use_shared_password: str or ~azure.mgmt.labservices.models.EnableState
:ivar admin_user: Required. Credentials for the admin user on the VM.
:vartype admin_user: ~azure.mgmt.labservices.models.Credentials
:ivar non_admin_user: Credentials for the non-admin user on the VM, if one exists.
:vartype non_admin_user: ~azure.mgmt.labservices.models.Credentials
"""
_validation = {
'create_option': {'required': True},
'image_reference': {'required': True},
'os_type': {'readonly': True},
'sku': {'required': True},
'usage_quota': {'required': True},
'admin_user': {'required': True},
}
_attribute_map = {
'create_option': {'key': 'createOption', 'type': 'str'},
'image_reference': {'key': 'imageReference', 'type': 'ImageReference'},
'os_type': {'key': 'osType', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'Sku'},
'additional_capabilities': {'key': 'additionalCapabilities', 'type': 'VirtualMachineAdditionalCapabilities'},
'usage_quota': {'key': 'usageQuota', 'type': 'duration'},
'use_shared_password': {'key': 'useSharedPassword', 'type': 'str'},
'admin_user': {'key': 'adminUser', 'type': 'Credentials'},
'non_admin_user': {'key': 'nonAdminUser', 'type': 'Credentials'},
}
def __init__(
self,
*,
create_option: Union[str, "CreateOption"],
image_reference: "ImageReference",
sku: "Sku",
usage_quota: datetime.timedelta,
admin_user: "Credentials",
additional_capabilities: Optional["VirtualMachineAdditionalCapabilities"] = None,
use_shared_password: Optional[Union[str, "EnableState"]] = None,
non_admin_user: Optional["Credentials"] = None,
**kwargs
):
"""
:keyword create_option: Required. Indicates what lab virtual machines are created from.
Possible values include: "Image", "TemplateVM".
:paramtype create_option: str or ~azure.mgmt.labservices.models.CreateOption
:keyword image_reference: Required. The image configuration for lab virtual machines.
:paramtype image_reference: ~azure.mgmt.labservices.models.ImageReference
:keyword sku: Required. The SKU for the lab. Defines the type of virtual machines used in the
lab.
:paramtype sku: ~azure.mgmt.labservices.models.Sku
:keyword additional_capabilities: Additional VM capabilities.
:paramtype additional_capabilities:
~azure.mgmt.labservices.models.VirtualMachineAdditionalCapabilities
:keyword usage_quota: Required. The initial quota alloted to each lab user. Must be a time span
between 0 and 9999 hours.
:paramtype usage_quota: ~datetime.timedelta
:keyword use_shared_password: Enabling this option will use the same password for all user VMs.
Possible values include: "Enabled", "Disabled".
:paramtype use_shared_password: str or ~azure.mgmt.labservices.models.EnableState
:keyword admin_user: Required. Credentials for the admin user on the VM.
:paramtype admin_user: ~azure.mgmt.labservices.models.Credentials
:keyword non_admin_user: Credentials for the non-admin user on the VM, if one exists.
:paramtype non_admin_user: ~azure.mgmt.labservices.models.Credentials
"""
super(VirtualMachineProfile, self).__init__(**kwargs)
self.create_option = create_option
self.image_reference = image_reference
self.os_type = None
self.sku = sku
self.additional_capabilities = additional_capabilities
self.usage_quota = usage_quota
self.use_shared_password = use_shared_password
self.admin_user = admin_user
self.non_admin_user = non_admin_user