azure.mgmt.labservices.operations module¶
-
class
azure.mgmt.labservices.operations.
ProviderOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ProviderOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Result of the request to list REST API operations.
Parameters: Returns: An iterator like instance of OperationMetadata
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
GlobalUsersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
GlobalUsersOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
get_environment
(user_name, environment_id, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the virtual machine details.
Parameters: - user_name (str) – The name of the user.
- environment_id (str) – The resourceId of the environment
- expand (str) – Specify the $expand query. Example: ‘properties($expand=environment)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: GetEnvironmentResponse or ClientRawResponse if raw=true
Return type: GetEnvironmentResponse or ClientRawResponse
Raises: CloudError
-
get_operation_batch_status
(user_name, urls, custom_headers=None, raw=False, **operation_config)[source]¶ Get batch operation status.
Parameters: Returns: OperationBatchStatusResponse or ClientRawResponse if raw=true
Return type: OperationBatchStatusResponse or ClientRawResponse
Raises: CloudError
-
get_operation_status
(user_name, operation_url, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the status of long running operation.
Parameters: - user_name (str) – The name of the user.
- operation_url (str) – The operation url of long running operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatusResponse or ClientRawResponse if raw=true
Return type: OperationStatusResponse or ClientRawResponse
Raises: CloudError
-
get_personal_preferences
(user_name, personal_preferences_operations_payload, custom_headers=None, raw=False, **operation_config)[source]¶ Get personal preferences for a user.
Parameters: - user_name (str) – The name of the user.
- personal_preferences_operations_payload (PersonalPreferencesOperationsPayload) – Represents payload for any Environment operations like get, start, stop, connect
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: GetPersonalPreferencesResponse or ClientRawResponse if raw=true
Return type: GetPersonalPreferencesResponse or ClientRawResponse
Raises: CloudError
-
list_environments
(user_name, lab_id=None, custom_headers=None, raw=False, **operation_config)[source]¶ List Environments for the user.
Parameters: Returns: ListEnvironmentsResponse or ClientRawResponse if raw=true
Return type: ListEnvironmentsResponse or ClientRawResponse
Raises: CloudError
-
list_labs
(user_name, custom_headers=None, raw=False, **operation_config)[source]¶ List labs for the user.
Parameters: Returns: ListLabsResponse or ClientRawResponse if raw=true
Return type: ListLabsResponse or ClientRawResponse
Raises: CloudError
-
register
(user_name, registration_code=None, custom_headers=None, raw=False, **operation_config)[source]¶ Register a user to a managed lab.
Parameters: Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
reset_password
(user_name, reset_password_payload, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Resets the user password on an environment This operation can take a while to complete.
Parameters: - user_name (str) – The name of the user.
- reset_password_payload (ResetPasswordPayload) – Represents the payload for resetting passwords.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
start_environment
(user_name, environment_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Starts an environment by starting all resources inside the environment. This operation can take a while to complete.
Parameters: - user_name (str) – The name of the user.
- environment_id (str) – The resourceId of the environment
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
stop_environment
(user_name, environment_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Stops an environment by stopping all resources inside the environment This operation can take a while to complete.
Parameters: - user_name (str) – The name of the user.
- environment_id (str) – The resourceId of the environment
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
LabAccountsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LabAccountsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
create_lab
(resource_group_name, lab_account_name, create_lab_properties, custom_headers=None, raw=False, **operation_config)[source]¶ Create a lab in a lab account.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- create_lab_properties (CreateLabProperties) – Properties for creating a managed lab and a default environment setting
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
create_or_update
(resource_group_name, lab_account_name, lab_account, custom_headers=None, raw=False, **operation_config)[source]¶ Create or replace an existing Lab Account.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_account (LabAccount) – Represents a lab account.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: LabAccount or ClientRawResponse if raw=true
Return type: LabAccount or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, lab_account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete lab account. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, lab_account_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get lab account.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- expand (str) – Specify the $expand query. Example: ‘properties($expand=sizeConfiguration)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: LabAccount or ClientRawResponse if raw=true
Return type: LabAccount or ClientRawResponse
Raises: CloudError
-
get_regional_availability
(resource_group_name, lab_account_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get regional availability information for each size category configured under a lab account.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: GetRegionalAvailabilityResponse or ClientRawResponse if raw=true
Return type: GetRegionalAvailabilityResponse or ClientRawResponse
Raises: CloudError
-
list_by_resource_group
(resource_group_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List lab accounts in a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- expand (str) – Specify the $expand query. Example: ‘properties($expand=sizeConfiguration)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of LabAccount
Return type: Raises: CloudError
-
list_by_subscription
(expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List lab accounts in a subscription.
Parameters: - expand (str) – Specify the $expand query. Example: ‘properties($expand=sizeConfiguration)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of LabAccount
Return type: Raises: CloudError
-
update
(resource_group_name, lab_account_name, lab_account, custom_headers=None, raw=False, **operation_config)[source]¶ Modify properties of lab accounts.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_account (LabAccountFragment) – Represents a lab account.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: LabAccount or ClientRawResponse if raw=true
Return type: LabAccount or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
get
(location_name, operation_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get operation.
Parameters: Returns: OperationResult or ClientRawResponse if raw=true
Return type: OperationResult or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
GalleryImagesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
GalleryImagesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
create_or_update
(resource_group_name, lab_account_name, gallery_image_name, gallery_image, custom_headers=None, raw=False, **operation_config)[source]¶ Create or replace an existing Gallery Image.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- gallery_image_name (str) – The name of the gallery Image.
- gallery_image (GalleryImage) – Represents an image from the Azure Marketplace
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: GalleryImage or ClientRawResponse if raw=true
Return type: GalleryImage or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, lab_account_name, gallery_image_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete gallery image.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- gallery_image_name (str) – The name of the gallery Image.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, lab_account_name, gallery_image_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get gallery image.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- gallery_image_name (str) – The name of the gallery Image.
- expand (str) – Specify the $expand query. Example: ‘properties($select=author)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: GalleryImage or ClientRawResponse if raw=true
Return type: GalleryImage or ClientRawResponse
Raises: CloudError
-
list
(resource_group_name, lab_account_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List gallery images in a given lab account.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- expand (str) – Specify the $expand query. Example: ‘properties($select=author)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of GalleryImage
Return type: Raises: CloudError
-
update
(resource_group_name, lab_account_name, gallery_image_name, gallery_image, custom_headers=None, raw=False, **operation_config)[source]¶ Modify properties of gallery images.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- gallery_image_name (str) – The name of the gallery Image.
- gallery_image (GalleryImageFragment) – Represents an image from the Azure Marketplace
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: GalleryImage or ClientRawResponse if raw=true
Return type: GalleryImage or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
LabsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LabsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
add_users
(resource_group_name, lab_account_name, lab_name, email_addresses, custom_headers=None, raw=False, **operation_config)[source]¶ Add users to a lab.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- email_addresses (list[str]) – List of user emails addresses to add to the lab.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
create_or_update
(resource_group_name, lab_account_name, lab_name, lab, custom_headers=None, raw=False, **operation_config)[source]¶ Create or replace an existing Lab.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- lab (Lab) – Represents a lab.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Lab or ClientRawResponse if raw=true
Return type: Lab or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, lab_account_name, lab_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete lab. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, lab_account_name, lab_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get lab.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- expand (str) – Specify the $expand query. Example: ‘properties($select=maxUsersInLab)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Lab or ClientRawResponse if raw=true
Return type: Lab or ClientRawResponse
Raises: CloudError
-
list
(resource_group_name, lab_account_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List labs in a given lab account.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- expand (str) – Specify the $expand query. Example: ‘properties($select=maxUsersInLab)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Lab
Return type: Raises: CloudError
-
register
(resource_group_name, lab_account_name, lab_name, custom_headers=None, raw=False, **operation_config)[source]¶ Register to managed lab.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
update
(resource_group_name, lab_account_name, lab_name, lab, custom_headers=None, raw=False, **operation_config)[source]¶ Modify properties of labs.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- lab (LabFragment) – Represents a lab.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Lab or ClientRawResponse if raw=true
Return type: Lab or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
EnvironmentSettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
EnvironmentSettingsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
claim_any
(resource_group_name, lab_account_name, lab_name, environment_setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Claims a random environment for a user in an environment settings.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
create_or_update
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_setting, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create or replace an existing Environment Setting. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_setting (EnvironmentSetting) – Represents settings of an environment, from which environment instances would be created
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns EnvironmentSetting or ClientRawResponse<EnvironmentSetting> if raw==True
Return type: AzureOperationPoller[EnvironmentSetting] or AzureOperationPoller[ClientRawResponse[EnvironmentSetting]]
Raises: CloudError
-
delete
(resource_group_name, lab_account_name, lab_name, environment_setting_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete environment setting. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, lab_account_name, lab_name, environment_setting_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get environment setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- expand (str) – Specify the $expand query. Example: ‘properties($select=publishingState)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EnvironmentSetting or ClientRawResponse if raw=true
Return type: EnvironmentSetting or ClientRawResponse
Raises: CloudError
-
list
(resource_group_name, lab_account_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List environment setting in a given lab.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- expand (str) – Specify the $expand query. Example: ‘properties($select=publishingState)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of EnvironmentSetting
Return type: Raises: CloudError
-
publish
(resource_group_name, lab_account_name, lab_name, environment_setting_name, use_existing_image=None, custom_headers=None, raw=False, **operation_config)[source]¶ Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- use_existing_image (bool) – Whether to use existing VM custom image when publishing.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
start
(resource_group_name, lab_account_name, lab_name, environment_setting_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Starts a template by starting all resources inside the template. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
stop
(resource_group_name, lab_account_name, lab_name, environment_setting_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Starts a template by starting all resources inside the template. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
update
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_setting, custom_headers=None, raw=False, **operation_config)[source]¶ Modify properties of environment setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_setting (EnvironmentSettingFragment) – Represents settings of an environment, from which environment instances would be created
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EnvironmentSetting or ClientRawResponse if raw=true
Return type: EnvironmentSetting or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
EnvironmentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
EnvironmentsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
claim
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Claims the environment and assigns it to the user.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
create_or_update
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, environment, custom_headers=None, raw=False, **operation_config)[source]¶ Create or replace an existing Environment.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- environment (Environment) – Represents an environment instance
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Environment or ClientRawResponse if raw=true
Return type: Environment or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete environment. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get environment.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- expand (str) – Specify the $expand query. Example: ‘properties($expand=networkInterface)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Environment or ClientRawResponse if raw=true
Return type: Environment or ClientRawResponse
Raises: CloudError
-
list
(resource_group_name, lab_account_name, lab_name, environment_setting_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List environments in a given environment setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- expand (str) – Specify the $expand query. Example: ‘properties($expand=networkInterface)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Environment
Return type: Raises: CloudError
-
reset_password
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, reset_password_payload, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Resets the user password on an environment This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- reset_password_payload (ResetPasswordPayload) – Represents the payload for resetting passwords.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
start
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Starts an environment by starting all resources inside the environment. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
stop
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Stops an environment by stopping all resources inside the environment This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
update
(resource_group_name, lab_account_name, lab_name, environment_setting_name, environment_name, environment, custom_headers=None, raw=False, **operation_config)[source]¶ Modify properties of environments.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- environment_setting_name (str) – The name of the environment Setting.
- environment_name (str) – The name of the environment.
- environment (EnvironmentFragment) – Represents an environment instance
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Environment or ClientRawResponse if raw=true
Return type: Environment or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
class
azure.mgmt.labservices.operations.
UsersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
UsersOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API version. Constant value: “2018-10-15”.
-
create_or_update
(resource_group_name, lab_account_name, lab_name, user_name, user, custom_headers=None, raw=False, **operation_config)[source]¶ Create or replace an existing User.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- user_name (str) – The name of the user.
- user (User) – The User registered to a lab
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: User or ClientRawResponse if raw=true
Return type: User or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, lab_account_name, lab_name, user_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete user. This operation can take a while to complete.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- user_name (str) – The name of the user.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, lab_account_name, lab_name, user_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get user.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- user_name (str) – The name of the user.
- expand (str) – Specify the $expand query. Example: ‘properties($select=email)’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: User or ClientRawResponse if raw=true
Return type: User or ClientRawResponse
Raises: CloudError
-
list
(resource_group_name, lab_account_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]¶ List users in a given lab.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- expand (str) – Specify the $expand query. Example: ‘properties($select=email)’
- filter (str) – The filter to apply to the operation.
- top (int) – The maximum number of resources to return from the operation.
- orderby (str) – The ordering expression for the results, using OData notation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of User
Return type: Raises: CloudError
-
update
(resource_group_name, lab_account_name, lab_name, user_name, user, custom_headers=None, raw=False, **operation_config)[source]¶ Modify properties of users.
Parameters: - resource_group_name (str) – The name of the resource group.
- lab_account_name (str) – The name of the lab Account.
- lab_name (str) – The name of the lab.
- user_name (str) – The name of the user.
- user (UserFragment) – The User registered to a lab
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: User or ClientRawResponse if raw=true
Return type: User or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.labservices.models' from '/usr/lib/python3/dist-packages/azure/mgmt/labservices/models/__init__.py'>¶