azure.mgmt.labservices.operations module¶
-
class
azure.mgmt.labservices.operations.
ImagesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’simages
attribute.-
create_or_update
(resource_group_name: str, lab_plan_name: str, image_name: str, body: _models.Image, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Image[source]¶ -
create_or_update
(resource_group_name: str, lab_plan_name: str, image_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Image Updates an image via PUT.
Updates an image resource via PUT. Creating new resources via PUT will not function.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_plan_name (str) – The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI. Required.
image_name (str) – The image name. Required.
body (Image or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Image or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, lab_plan_name: str, image_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Image[source]¶ Gets an image.
Gets an image resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Image or the result of cls(response)
- Return type
- Raises
-
list_by_lab_plan
(resource_group_name: str, lab_plan_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.Image][source]¶ Gets all images.
Gets all images from galleries attached to a lab plan.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_plan_name (str) – The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI. Required.
filter (str) – The filter to apply to the operation. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Image or the result of cls(response)
- Return type
- Raises
-
update
(resource_group_name: str, lab_plan_name: str, image_name: str, body: _models.ImageUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Image[source]¶ -
update
(resource_group_name: str, lab_plan_name: str, image_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Image Updates an image.
Updates an image resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_plan_name (str) – The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI. Required.
image_name (str) – The image name. Required.
body (ImageUpdate or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Image or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
LabPlansOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’slab_plans
attribute.-
begin_create_or_update
(resource_group_name: str, lab_plan_name: str, body: _models.LabPlan, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LabPlan][source]¶ -
begin_create_or_update
(resource_group_name: str, lab_plan_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LabPlan] Updates or creates a Lab Plan resource.
Operation to create or update a Lab Plan resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_plan_name (str) – The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI. Required.
body (LabPlan or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either LabPlan or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, lab_plan_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a Lab Plan resource.
Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_save_image
(resource_group_name: str, lab_plan_name: str, body: _models.SaveImageBody, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶ -
begin_save_image
(resource_group_name: str, lab_plan_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None] Save an image from a lab VM to the attached shared image gallery.
Saves an image from a lab VM to the attached shared image gallery.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_plan_name (str) – The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI. Required.
body (SaveImageBody or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_update
(resource_group_name: str, lab_plan_name: str, body: _models.LabPlanUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LabPlan][source]¶ -
begin_update
(resource_group_name: str, lab_plan_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LabPlan] Updates a Lab Plan resource.
Operation to update a Lab Plan resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_plan_name (str) – The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI. Required.
body (LabPlanUpdate or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either LabPlan or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, lab_plan_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.LabPlan[source]¶ Retrieves a Lab Plan resource.
Retrieves the properties of a Lab Plan.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LabPlan or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.LabPlan][source]¶ Get all lab plans for a subscription and resource group.
Returns a list of all lab plans for a subscription and resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LabPlan or the result of cls(response)
- Return type
- Raises
-
list_by_subscription
(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.LabPlan][source]¶ Get all lab plans for a subscription.
Returns a list of all lab plans within a subscription.
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
LabsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’slabs
attribute.-
begin_create_or_update
(resource_group_name: str, lab_name: str, body: _models.Lab, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Lab][source]¶ -
begin_create_or_update
(resource_group_name: str, lab_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Lab] Create or update a lab resource.
Operation to create or update a lab resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
body (Lab or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Lab or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a lab resource.
Operation to delete a lab resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_publish
(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Publish or re-publish a lab.
Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_sync_group
(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Manually sync the lab group.
Action used to manually kick off an AAD group sync job.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_update
(resource_group_name: str, lab_name: str, body: _models.LabUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Lab][source]¶ -
begin_update
(resource_group_name: str, lab_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Lab] Update a lab resource.
Operation to update a lab resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
body (LabUpdate or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Lab or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Lab[source]¶ Get a lab resource.
Returns the properties of a lab resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Lab or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.Lab][source]¶ Get all labs for a subscription and resource group.
Returns a list of all labs in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Lab or the result of cls(response)
- Return type
- Raises
-
list_by_subscription
(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.Lab][source]¶ Get all labs for a subscription.
Returns a list of all labs for a subscription.
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
OperationResultsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’soperation_results
attribute.-
get
(operation_result_id: str, **kwargs: Any) → Optional[azure.mgmt.labservices.models._models_py3.OperationResult][source]¶ Get an azure operation result.
Returns an azure operation result.
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
Operations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’soperations
attribute.-
list
(**kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.Operation][source]¶ Get all operations.
Returns a list of all operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Operation or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
SchedulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’sschedules
attribute.-
begin_delete
(resource_group_name: str, lab_name: str, schedule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a schedule resource.
Operation to delete a schedule resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
create_or_update
(resource_group_name: str, lab_name: str, schedule_name: str, body: _models.Schedule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule[source]¶ -
create_or_update
(resource_group_name: str, lab_name: str, schedule_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule Create or update a lab schedule.
Operation to create or update a lab schedule.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs. Required.
body (Schedule or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Schedule or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, lab_name: str, schedule_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Schedule[source]¶ Get a lab Schedule.
Returns the properties of a lab Schedule.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Schedule or the result of cls(response)
- Return type
- Raises
-
list_by_lab
(resource_group_name: str, lab_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.Schedule][source]¶ Get all schedules for a lab.
Returns a list of all schedules for a lab.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
filter (str) – The filter to apply to the operation. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Schedule or the result of cls(response)
- Return type
- Raises
-
update
(resource_group_name: str, lab_name: str, schedule_name: str, body: _models.ScheduleUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule[source]¶ -
update
(resource_group_name: str, lab_name: str, schedule_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule Update a lab schedule.
Operation to update a lab schedule.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs. Required.
body (ScheduleUpdate or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Schedule or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
SkusOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’sskus
attribute.-
list
(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.LabServicesSku][source]¶ Gets the Azure Lab Services resource SKUs.
Returns a list of Azure Lab Services resource SKUs.
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
UsagesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’susages
attribute.-
list_by_location
(location: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.Usage][source]¶ Gets the list of usages.
Returns list of usage per SKU family for the specified subscription in the specified region.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Usage or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
UsersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’susers
attribute.-
begin_create_or_update
(resource_group_name: str, lab_name: str, user_name: str, body: _models.User, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.User][source]¶ -
begin_create_or_update
(resource_group_name: str, lab_name: str, user_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.User] Create or update a lab user.
Operation to create or update a lab user.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Required.
body (User or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either User or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, lab_name: str, user_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a user resource.
Operation to delete a user resource.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_invite
(resource_group_name: str, lab_name: str, user_name: str, body: _models.InviteBody, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶ -
begin_invite
(resource_group_name: str, lab_name: str, user_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None] Invite a user to a lab.
Operation to invite a user to a lab.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Required.
body (InviteBody or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_update
(resource_group_name: str, lab_name: str, user_name: str, body: _models.UserUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.User][source]¶ -
begin_update
(resource_group_name: str, lab_name: str, user_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.User] Update a lab user.
Operation to update a lab user.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Required.
body (UserUpdate or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either User or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, lab_name: str, user_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.User[source]¶ Get a lab user.
Returns the properties of a lab user.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
User or the result of cls(response)
- Return type
- Raises
-
list_by_lab
(resource_group_name: str, lab_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.User][source]¶ Get all users for a lab.
Returns a list of all users for a lab.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
filter (str) – The filter to apply to the operation. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either User or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-
-
class
azure.mgmt.labservices.operations.
VirtualMachinesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ManagedLabsClient
’svirtual_machines
attribute.-
begin_redeploy
(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_reimage
(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Re-image a lab virtual machine.
Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_reset_password
(resource_group_name: str, lab_name: str, virtual_machine_name: str, body: _models.ResetPasswordBody, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶ -
begin_reset_password
(resource_group_name: str, lab_name: str, virtual_machine_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None] Reset a lab virtual machine password.
Resets a lab virtual machine password.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs. Required.
body (ResetPasswordBody or IO) – The request body. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_start
(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Start a lab virtual machine.
Action to start a lab virtual machine.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_stop
(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Stop a lab virtual machine.
Action to stop a lab virtual machine.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.VirtualMachine[source]¶ Get a lab virtual machine.
Returns the properties for a lab virtual machine.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualMachine or the result of cls(response)
- Return type
- Raises
-
list_by_lab
(resource_group_name: str, lab_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.VirtualMachine][source]¶ Get all virtual machines for a lab.
Returns a list of all virtual machines for a lab.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
lab_name (str) – The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
filter (str) – The filter to apply to the operation. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either VirtualMachine or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.labservices.models' from '/mnt/vss/_work/1/s/sdk/labservices/azure-mgmt-labservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/labservices/models/__init__.py'>¶
-