azure.mgmt.labservices.operations module

class azure.mgmt.labservices.operations.ImagesOperations(client, config, serializer, deserializer)

Bases: object

ImagesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, lab_plan_name: str, image_name: str, body: azure.mgmt.labservices.models._models_py3.Image, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.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.

• 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.

• image_name (str) – The image name.

• body (Image) – The request body.

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

Image

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, lab_plan_name: str, image_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Image

Gets an image.

Gets an image resource.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• 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.

• image_name (str) – The image name.

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

Image

Raises

~azure.core.exceptions.HttpResponseError

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.PagedImages]

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.

• 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.

• filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedImages or the result of cls(response)

Return type

ItemPaged[PagedImages]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, lab_plan_name: str, image_name: str, body: azure.mgmt.labservices.models._models_py3.ImageUpdate, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Image

Updates an image.

Updates an image resource.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• 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.

• image_name (str) – The image name.

• body (ImageUpdate) – The request body.

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

Image

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

LabPlansOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, lab_plan_name: str, body: azure.mgmt.labservices.models._models_py3.LabPlan, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.labservices.models._models_py3.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.

• 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.

• body (LabPlan) – The request body.

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 LabPlan or the result of cls(response)

Return type

LROPoller[LabPlan]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, lab_plan_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• 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.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_save_image(resource_group_name: str, lab_plan_name: str, body: azure.mgmt.labservices.models._models_py3.SaveImageBody, **kwargs: Any) → azure.core.polling._poller.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.

• 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.

• body (SaveImageBody) – The request body.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, lab_plan_name: str, body: azure.mgmt.labservices.models._models_py3.LabPlanUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.labservices.models._models_py3.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.

• 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.

• body (LabPlanUpdate) – The request body.

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 LabPlan or the result of cls(response)

Return type

LROPoller[LabPlan]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, lab_plan_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.LabPlan

Retrieves a Lab Plan resource.

Retrieves the properties of a Lab Plan.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• 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.

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

LabPlan

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedLabPlans]

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedLabPlans or the result of cls(response)

Return type

ItemPaged[PagedLabPlans]

Raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedLabPlans]

Get all lab plans for a subscription.

Returns a list of all lab plans within a subscription.

Parameters

filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedLabPlans or the result of cls(response)

Return type

ItemPaged[PagedLabPlans]

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

LabsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, lab_name: str, body: azure.mgmt.labservices.models._models_py3.Lab, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.labservices.models._models_py3.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• body (Lab) – The request body.

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 Lab or the result of cls(response)

Return type

LROPoller[Lab]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes a lab resource.

Operation to delete a lab resource.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_publish(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_sync_group(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Manually sync the lab group.

Action used to manually kick off an AAD group sync job.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, lab_name: str, body: azure.mgmt.labservices.models._models_py3.LabUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.labservices.models._models_py3.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• body (LabUpdate) – The request body.

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 Lab or the result of cls(response)

Return type

LROPoller[Lab]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, lab_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Lab

Get a lab resource.

Returns the properties of a lab resource.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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

Lab

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedLabs]

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedLabs or the result of cls(response)

Return type

ItemPaged[PagedLabs]

Raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedLabs]

Get all labs for a subscription.

Returns a list of all labs for a subscription.

Parameters

filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedLabs or the result of cls(response)

Return type

ItemPaged[PagedLabs]

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

OperationResultsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(operation_result_id: str, **kwargs: Any) → Optional[azure.mgmt.labservices.models._models_py3.OperationResult]

Get an azure operation result.

Returns an azure operation result.

Parameters

operation_result_id (str) – The operation result ID / name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationResult, or the result of cls(response)

Return type

OperationResult or None

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

Operations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.OperationListResult]

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 OperationListResult or the result of cls(response)

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

SchedulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_delete(resource_group_name: str, lab_name: str, schedule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, lab_name: str, schedule_name: str, body: azure.mgmt.labservices.models._models_py3.Schedule, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.

• body (Schedule) – The request body.

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

Schedule

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, lab_name: str, schedule_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.Schedule

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.

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

Schedule

Raises

~azure.core.exceptions.HttpResponseError

list_by_lab(resource_group_name: str, lab_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedSchedules]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedSchedules or the result of cls(response)

Return type

ItemPaged[PagedSchedules]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, lab_name: str, schedule_name: str, body: azure.mgmt.labservices.models._models_py3.ScheduleUpdate, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• schedule_name (str) – The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.

• body (ScheduleUpdate) – The request body.

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

Schedule

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

SkusOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedLabServicesSkus]

Gets all the Azure Lab Services resource SKUs.

Returns a list of all the Azure Lab Services resource SKUs.

Parameters

filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedLabServicesSkus or the result of cls(response)

Return type

ItemPaged[PagedLabServicesSkus]

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

UsagesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_by_location(location: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.ListUsagesResult]

Gets the list of usages.

Returns list of usage per SKU family for the specified subscription in the specified region.

Parameters

• location (str) – The location name.

• filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ListUsagesResult or the result of cls(response)

Return type

ItemPaged[ListUsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

UsersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, body: azure.mgmt.labservices.models._models_py3.User, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.labservices.models._models_py3.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

• body (User) – The request body.

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 User or the result of cls(response)

Return type

LROPoller[User]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, lab_name: str, user_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_invite(resource_group_name: str, lab_name: str, user_name: str, body: azure.mgmt.labservices.models._models_py3.InviteBody, **kwargs: Any) → azure.core.polling._poller.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

• body (InviteBody) – The request body.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, lab_name: str, user_name: str, body: azure.mgmt.labservices.models._models_py3.UserUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.labservices.models._models_py3.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

• body (UserUpdate) – The request body.

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 User or the result of cls(response)

Return type

LROPoller[User]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, lab_name: str, user_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.User

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• user_name (str) – The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

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

User

Raises

~azure.core.exceptions.HttpResponseError

list_by_lab(resource_group_name: str, lab_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedUsers]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedUsers or the result of cls(response)

Return type

ItemPaged[PagedUsers]

Raises

~azure.core.exceptions.HttpResponseError

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(client, config, serializer, deserializer)

Bases: object

VirtualMachinesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_redeploy(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_reimage(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_reset_password(resource_group_name: str, lab_name: str, virtual_machine_name: str, body: azure.mgmt.labservices.models._models_py3.ResetPasswordBody, **kwargs: Any) → azure.core.polling._poller.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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

• body (ResetPasswordBody) – The request body.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_start(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_stop(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

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

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, lab_name: str, virtual_machine_name: str, **kwargs: Any) → azure.mgmt.labservices.models._models_py3.VirtualMachine

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• virtual_machine_name (str) – The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

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

VirtualMachine

Raises

~azure.core.exceptions.HttpResponseError

list_by_lab(resource_group_name: str, lab_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.labservices.models._models_py3.PagedVirtualMachines]

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.

• lab_name (str) – The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

• filter (str) – The filter to apply to the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PagedVirtualMachines or the result of cls(response)

Return type

ItemPaged[PagedVirtualMachines]

Raises

~azure.core.exceptions.HttpResponseError

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'>