azure.mgmt.compute.v2019_03_01.operations module

class azure.mgmt.compute.v2019_03_01.operations.AvailabilitySetsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s availability_sets attribute.

create_or_update(resource_group_name: str, availability_set_name: str, parameters: _models.AvailabilitySet, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AvailabilitySet

create_or_update(resource_group_name: str, availability_set_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AvailabilitySet

Create or update an availability set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• availability_set_name (str) – The name of the availability set. Required.

• parameters (AvailabilitySet or IO) – Parameters supplied to the Create Availability Set operation. Is either a AvailabilitySet 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

Returns

AvailabilitySet or the result of cls(response)

Return type

AvailabilitySet

Raises

HttpResponseError –

delete(resource_group_name: str, availability_set_name: str, **kwargs: Any) → None

Delete an availability set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• availability_set_name (str) – The name of the availability set. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, availability_set_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.AvailabilitySet

Retrieves information about an availability set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• availability_set_name (str) – The name of the availability set. Required.

Keyword Arguments

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

Returns

AvailabilitySet or the result of cls(response)

Return type

AvailabilitySet

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.AvailabilitySet]

Lists all availability sets in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[AvailabilitySet]

Raises

HttpResponseError –

list_available_sizes(resource_group_name: str, availability_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineSize]

Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• availability_set_name (str) – The name of the availability set. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineSize]

Raises

HttpResponseError –

list_by_subscription(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.AvailabilitySet]

Lists all availability sets in a subscription.

Parameters

expand (str) – The expand expression to apply to the operation. Allowed values are ‘instanceView’. 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 AvailabilitySet or the result of cls(response)

Return type

ItemPaged[AvailabilitySet]

Raises

HttpResponseError –

update(resource_group_name: str, availability_set_name: str, parameters: _models.AvailabilitySetUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AvailabilitySet

update(resource_group_name: str, availability_set_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AvailabilitySet

Update an availability set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• availability_set_name (str) – The name of the availability set. Required.

• parameters (AvailabilitySetUpdate or IO) – Parameters supplied to the Update Availability Set operation. Is either a AvailabilitySetUpdate 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

Returns

AvailabilitySet or the result of cls(response)

Return type

AvailabilitySet

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.DedicatedHostGroupsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s dedicated_host_groups attribute.

create_or_update(resource_group_name: str, host_group_name: str, parameters: _models.DedicatedHostGroup, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DedicatedHostGroup

create_or_update(resource_group_name: str, host_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DedicatedHostGroup

Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596).

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

• parameters (DedicatedHostGroup or IO) – Parameters supplied to the Create Dedicated Host Group. Is either a DedicatedHostGroup 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

Returns

DedicatedHostGroup or the result of cls(response)

Return type

DedicatedHostGroup

Raises

HttpResponseError –

delete(resource_group_name: str, host_group_name: str, **kwargs: Any) → None

Delete a dedicated host group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, host_group_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.DedicatedHostGroup

Retrieves information about a dedicated host group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

Keyword Arguments

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

Returns

DedicatedHostGroup or the result of cls(response)

Return type

DedicatedHostGroup

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.DedicatedHostGroup]

Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DedicatedHostGroup]

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.DedicatedHostGroup]

Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DedicatedHostGroup]

Raises

HttpResponseError –

update(resource_group_name: str, host_group_name: str, parameters: _models.DedicatedHostGroupUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DedicatedHostGroup

update(resource_group_name: str, host_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DedicatedHostGroup

Update an dedicated host group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

• parameters (DedicatedHostGroupUpdate or IO) – Parameters supplied to the Update Dedicated Host Group operation. Is either a DedicatedHostGroupUpdate 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

Returns

DedicatedHostGroup or the result of cls(response)

Return type

DedicatedHostGroup

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.DedicatedHostsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s dedicated_hosts attribute.

begin_create_or_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: _models.DedicatedHost, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DedicatedHost]

begin_create_or_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DedicatedHost]

Create or update a dedicated host .

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

• host_name (str) – The name of the dedicated host . Required.

• parameters (DedicatedHost or IO) – Parameters supplied to the Create Dedicated Host. Is either a DedicatedHost 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 DedicatedHost or the result of cls(response)

Return type

LROPoller[DedicatedHost]

Raises

HttpResponseError –

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

Delete a dedicated host.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

• host_name (str) – The name of the dedicated host. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: _models.DedicatedHostUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DedicatedHost]

begin_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DedicatedHost]

Update an dedicated host .

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

• host_name (str) – The name of the dedicated host . Required.

• parameters (DedicatedHostUpdate or IO) – Parameters supplied to the Update Dedicated Host operation. Is either a DedicatedHostUpdate 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 DedicatedHost or the result of cls(response)

Return type

LROPoller[DedicatedHost]

Raises

HttpResponseError –

get(resource_group_name: str, host_group_name: str, host_name: str, expand: Literal[instanceView] = 'instanceView', **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.DedicatedHost

Retrieves information about a dedicated host.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

• host_name (str) – The name of the dedicated host. Required.

• expand (str) – The expand expression to apply on the operation. Known values are “instanceView” and None. Default value is “instanceView”.

Keyword Arguments

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

Returns

DedicatedHost or the result of cls(response)

Return type

DedicatedHost

Raises

HttpResponseError –

list_by_host_group(resource_group_name: str, host_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.DedicatedHost]

Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• host_group_name (str) – The name of the dedicated host group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DedicatedHost]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.DisksOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s disks attribute.

begin_create_or_update(resource_group_name: str, disk_name: str, disk: _models.Disk, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Disk]

begin_create_or_update(resource_group_name: str, disk_name: str, disk: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Disk]

Creates or updates a disk.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. Required.

• disk (Disk or IO) – Disk object supplied in the body of the Put disk operation. Is either a Disk 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 Disk or the result of cls(response)

Return type

LROPoller[Disk]

Raises

HttpResponseError –

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

Deletes a disk.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. 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

LROPoller[None]

Raises

HttpResponseError –

begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: _models.GrantAccessData, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AccessUri]

begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AccessUri]

Grants access to a disk.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. Required.

• grant_access_data (GrantAccessData or IO) – Access data object supplied in the body of the get disk access operation. Is either a GrantAccessData 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 AccessUri or the result of cls(response)

Return type

LROPoller[AccessUri]

Raises

HttpResponseError –

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

Revokes access to a disk.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, disk_name: str, disk: _models.DiskUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Disk]

begin_update(resource_group_name: str, disk_name: str, disk: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Disk]

Updates (patches) a disk.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. Required.

• disk (DiskUpdate or IO) – Disk object supplied in the body of the Patch disk operation. Is either a DiskUpdate 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 Disk or the result of cls(response)

Return type

LROPoller[Disk]

Raises

HttpResponseError –

get(resource_group_name: str, disk_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.Disk

Gets information about a disk.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. Required.

Keyword Arguments

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

Returns

Disk or the result of cls(response)

Return type

Disk

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Disk]

Lists all the disks under a subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Disk]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Disk]

Lists all the disks under a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Disk]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.GalleriesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s galleries attribute.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery: _models.Gallery, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Gallery]

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Gallery]

Create or update a Shared Image Gallery.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. Required.

• gallery (Gallery or IO) – Parameters supplied to the create or update Shared Image Gallery operation. Is either a Gallery 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 Gallery or the result of cls(response)

Return type

LROPoller[Gallery]

Raises

HttpResponseError –

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

Delete a Shared Image Gallery.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery to be deleted. 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, gallery_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.Gallery

Retrieves information about a Shared Image Gallery.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery. Required.

Keyword Arguments

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

Returns

Gallery or the result of cls(response)

Return type

Gallery

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Gallery]

List galleries under a subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Gallery]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Gallery]

List galleries under a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Gallery]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.GalleryApplicationVersionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s gallery_application_versions attribute.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application_version_name: str, gallery_application_version: _models.GalleryApplicationVersion, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryApplicationVersion]

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application_version_name: str, gallery_application_version: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryApplicationVersion]

Create or update a gallery Application Version.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition resides. Required.

• gallery_application_name (str) – The name of the gallery Application Definition in which the Application Version is to be created. Required.

• gallery_application_version_name (str) – The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.:code:<MinorVersion>.:code:<Patch>. Required.

• gallery_application_version (GalleryApplicationVersion or IO) – Parameters supplied to the create or update gallery Application Version operation. Is either a GalleryApplicationVersion 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 GalleryApplicationVersion or the result of cls(response)

Return type

LROPoller[GalleryApplicationVersion]

Raises

HttpResponseError –

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

Delete a gallery Application Version.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition resides. Required.

• gallery_application_name (str) – The name of the gallery Application Definition in which the Application Version resides. Required.

• gallery_application_version_name (str) – The name of the gallery Application Version to be deleted. 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application_version_name: str, expand: Optional[Union[str, azure.mgmt.compute.v2019_03_01.models._compute_management_client_enums.ReplicationStatusTypes]] = None, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryApplicationVersion

Retrieves information about a gallery Application Version.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition resides. Required.

• gallery_application_name (str) – The name of the gallery Application Definition in which the Application Version resides. Required.

• gallery_application_version_name (str) – The name of the gallery Application Version to be retrieved. Required.

• expand (str or ReplicationStatusTypes) – The expand expression to apply on the operation. “ReplicationStatus” Default value is None.

Keyword Arguments

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

Returns

GalleryApplicationVersion or the result of cls(response)

Return type

GalleryApplicationVersion

Raises

HttpResponseError –

list_by_gallery_application(resource_group_name: str, gallery_name: str, gallery_application_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryApplicationVersion]

List gallery Application Versions in a gallery Application Definition.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition resides. Required.

• gallery_application_name (str) – The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GalleryApplicationVersion]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.GalleryApplicationsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s gallery_applications attribute.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application: _models.GalleryApplication, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryApplication]

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryApplication]

Create or update a gallery Application Definition.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition is to be created. Required.

• gallery_application_name (str) – The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. Required.

• gallery_application (GalleryApplication or IO) – Parameters supplied to the create or update gallery Application operation. Is either a GalleryApplication 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 GalleryApplication or the result of cls(response)

Return type

LROPoller[GalleryApplication]

Raises

HttpResponseError –

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

Delete a gallery Application.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition is to be deleted. Required.

• gallery_application_name (str) – The name of the gallery Application Definition to be deleted. 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, gallery_name: str, gallery_application_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryApplication

Retrieves information about a gallery Application Definition.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery from which the Application Definitions are to be retrieved. Required.

• gallery_application_name (str) – The name of the gallery Application Definition to be retrieved. Required.

Keyword Arguments

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

Returns

GalleryApplication or the result of cls(response)

Return type

GalleryApplication

Raises

HttpResponseError –

list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryApplication]

List gallery Application Definitions in a gallery.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Application Gallery from which Application Definitions are to be listed. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GalleryApplication]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.GalleryImageVersionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s gallery_image_versions attribute.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, gallery_image_version: _models.GalleryImageVersion, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryImageVersion]

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, gallery_image_version: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryImageVersion]

Create or update a gallery Image Version.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition resides. Required.

• gallery_image_name (str) – The name of the gallery Image Definition in which the Image Version is to be created. Required.

• gallery_image_version_name (str) – The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.:code:<MinorVersion>.:code:<Patch>. Required.

• gallery_image_version (GalleryImageVersion or IO) – Parameters supplied to the create or update gallery Image Version operation. Is either a GalleryImageVersion 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 GalleryImageVersion or the result of cls(response)

Return type

LROPoller[GalleryImageVersion]

Raises

HttpResponseError –

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

Delete a gallery Image Version.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition resides. Required.

• gallery_image_name (str) – The name of the gallery Image Definition in which the Image Version resides. Required.

• gallery_image_version_name (str) – The name of the gallery Image Version to be deleted. 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, expand: Optional[Union[str, azure.mgmt.compute.v2019_03_01.models._compute_management_client_enums.ReplicationStatusTypes]] = None, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryImageVersion

Retrieves information about a gallery Image Version.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition resides. Required.

• gallery_image_name (str) – The name of the gallery Image Definition in which the Image Version resides. Required.

• gallery_image_version_name (str) – The name of the gallery Image Version to be retrieved. Required.

• expand (str or ReplicationStatusTypes) – The expand expression to apply on the operation. “ReplicationStatus” Default value is None.

Keyword Arguments

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

Returns

GalleryImageVersion or the result of cls(response)

Return type

GalleryImageVersion

Raises

HttpResponseError –

list_by_gallery_image(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryImageVersion]

List gallery Image Versions in a gallery Image Definition.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition resides. Required.

• gallery_image_name (str) – The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GalleryImageVersion]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.GalleryImagesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s gallery_images attribute.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image: _models.GalleryImage, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryImage]

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GalleryImage]

Create or update a gallery Image Definition.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition is to be created. Required.

• gallery_image_name (str) – The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. Required.

• gallery_image (GalleryImage or IO) – Parameters supplied to the create or update gallery image operation. Is either a GalleryImage 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 GalleryImage or the result of cls(response)

Return type

LROPoller[GalleryImage]

Raises

HttpResponseError –

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

Delete a gallery image.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition is to be deleted. Required.

• gallery_image_name (str) – The name of the gallery Image Definition to be deleted. 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryImage

Retrieves information about a gallery Image Definition.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery from which the Image Definitions are to be retrieved. Required.

• gallery_image_name (str) – The name of the gallery Image Definition to be retrieved. Required.

Keyword Arguments

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

Returns

GalleryImage or the result of cls(response)

Return type

GalleryImage

Raises

HttpResponseError –

list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryImage]

List gallery Image Definitions in a gallery.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• gallery_name (str) – The name of the Shared Image Gallery from which Image Definitions are to be listed. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GalleryImage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.ImagesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s images attribute.

begin_create_or_update(resource_group_name: str, image_name: str, parameters: _models.Image, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Image]

begin_create_or_update(resource_group_name: str, image_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Image]

Create or update an image.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• image_name (str) – The name of the image. Required.

• parameters (Image or IO) – Parameters supplied to the Create Image operation. Is either a Image 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 Image or the result of cls(response)

Return type

LROPoller[Image]

Raises

HttpResponseError –

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

Deletes an Image.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• image_name (str) – The name of the image. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, image_name: str, parameters: _models.ImageUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Image]

begin_update(resource_group_name: str, image_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Image]

Update an image.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• image_name (str) – The name of the image. Required.

• parameters (ImageUpdate or IO) – Parameters supplied to the Update Image operation. Is either a ImageUpdate 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 Image or the result of cls(response)

Return type

LROPoller[Image]

Raises

HttpResponseError –

get(resource_group_name: str, image_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.Image

Gets an image.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• image_name (str) – The name of the image. Required.

• expand (str) – The expand expression to apply on the operation. Default value is None.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Image]

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

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

ItemPaged[Image]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Image]

Gets the list of images under a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

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

ItemPaged[Image]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.LogAnalyticsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s log_analytics attribute.

begin_export_request_rate_by_interval(location: str, parameters: _models.RequestRateByIntervalInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LogAnalyticsOperationResult]

begin_export_request_rate_by_interval(location: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LogAnalyticsOperationResult]

Export logs that show Api requests made by this subscription in the given time window to show throttling activities.

Parameters

• location (str) – The location upon which virtual-machine-sizes is queried. Required.

• parameters (RequestRateByIntervalInput or IO) – Parameters supplied to the LogAnalytics getRequestRateByInterval Api. Is either a RequestRateByIntervalInput 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 LogAnalyticsOperationResult or the result of cls(response)

Return type

LROPoller[LogAnalyticsOperationResult]

Raises

HttpResponseError –

begin_export_throttled_requests(location: str, parameters: _models.ThrottledRequestsInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LogAnalyticsOperationResult]

begin_export_throttled_requests(location: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LogAnalyticsOperationResult]

Export logs that show total throttled Api requests for this subscription in the given time window.

Parameters

• location (str) – The location upon which virtual-machine-sizes is queried. Required.

• parameters (ThrottledRequestsInput or IO) – Parameters supplied to the LogAnalytics getThrottledRequests Api. Is either a ThrottledRequestsInput 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 LogAnalyticsOperationResult or the result of cls(response)

Return type

LROPoller[LogAnalyticsOperationResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.ComputeOperationValue]

Gets a list of compute operations.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ComputeOperationValue]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.ProximityPlacementGroupsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s proximity_placement_groups attribute.

create_or_update(resource_group_name: str, proximity_placement_group_name: str, parameters: _models.ProximityPlacementGroup, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProximityPlacementGroup

create_or_update(resource_group_name: str, proximity_placement_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProximityPlacementGroup

Create or update a proximity placement group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• proximity_placement_group_name (str) – The name of the proximity placement group. Required.

• parameters (ProximityPlacementGroup or IO) – Parameters supplied to the Create Proximity Placement Group operation. Is either a ProximityPlacementGroup 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

Returns

ProximityPlacementGroup or the result of cls(response)

Return type

ProximityPlacementGroup

Raises

HttpResponseError –

delete(resource_group_name: str, proximity_placement_group_name: str, **kwargs: Any) → None

Delete a proximity placement group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• proximity_placement_group_name (str) – The name of the proximity placement group. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, proximity_placement_group_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.ProximityPlacementGroup

Retrieves information about a proximity placement group .

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• proximity_placement_group_name (str) – The name of the proximity placement group. Required.

Keyword Arguments

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

Returns

ProximityPlacementGroup or the result of cls(response)

Return type

ProximityPlacementGroup

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.ProximityPlacementGroup]

Lists all proximity placement groups in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ProximityPlacementGroup]

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.ProximityPlacementGroup]

Lists all proximity placement groups in a subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ProximityPlacementGroup]

Raises

HttpResponseError –

update(resource_group_name: str, proximity_placement_group_name: str, parameters: _models.ProximityPlacementGroupUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProximityPlacementGroup

update(resource_group_name: str, proximity_placement_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProximityPlacementGroup

Update a proximity placement group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• proximity_placement_group_name (str) – The name of the proximity placement group. Required.

• parameters (ProximityPlacementGroupUpdate or IO) – Parameters supplied to the Update Proximity Placement Group operation. Is either a ProximityPlacementGroupUpdate 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

Returns

ProximityPlacementGroup or the result of cls(response)

Return type

ProximityPlacementGroup

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s snapshots attribute.

begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: _models.Snapshot, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Snapshot]

begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Snapshot]

Creates or updates a snapshot.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. Required.

• snapshot (Snapshot or IO) – Snapshot object supplied in the body of the Put disk operation. Is either a Snapshot 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 Snapshot or the result of cls(response)

Return type

LROPoller[Snapshot]

Raises

HttpResponseError –

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

Deletes a snapshot.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. 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

LROPoller[None]

Raises

HttpResponseError –

begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: _models.GrantAccessData, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AccessUri]

begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AccessUri]

Grants access to a snapshot.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. Required.

• grant_access_data (GrantAccessData or IO) – Access data object supplied in the body of the get snapshot access operation. Is either a GrantAccessData 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 AccessUri or the result of cls(response)

Return type

LROPoller[AccessUri]

Raises

HttpResponseError –

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

Revokes access to a snapshot.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, snapshot_name: str, snapshot: _models.SnapshotUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Snapshot]

begin_update(resource_group_name: str, snapshot_name: str, snapshot: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Snapshot]

Updates (patches) a snapshot.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. Required.

• snapshot (SnapshotUpdate or IO) – Snapshot object supplied in the body of the Patch snapshot operation. Is either a SnapshotUpdate 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 Snapshot or the result of cls(response)

Return type

LROPoller[Snapshot]

Raises

HttpResponseError –

get(resource_group_name: str, snapshot_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.Snapshot

Gets information about a snapshot.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. Required.

Keyword Arguments

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

Returns

Snapshot or the result of cls(response)

Return type

Snapshot

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Snapshot]

Lists snapshots under a subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Snapshot]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Snapshot]

Lists snapshots under a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Snapshot]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.UsageOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s usage attribute.

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.Usage]

Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.

Parameters

location (str) – The location for which resource usage is queried. Required.

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

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineExtensionImagesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_extension_images attribute.

get(location: str, publisher_name: str, type: str, version: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineExtensionImage

Gets a virtual machine extension image.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – Required.

• type (str) – Required.

• version (str) – Required.

Keyword Arguments

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

Returns

VirtualMachineExtensionImage or the result of cls(response)

Return type

VirtualMachineExtensionImage

Raises

HttpResponseError –

list_types(location: str, publisher_name: str, **kwargs: Any) → List[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineExtensionImage]

Gets a list of virtual machine extension image types.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – Required.

Keyword Arguments

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

Returns

list of VirtualMachineExtensionImage or the result of cls(response)

Return type

list[VirtualMachineExtensionImage]

Raises

HttpResponseError –

list_versions(location: str, publisher_name: str, type: str, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → List[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineExtensionImage]

Gets a list of virtual machine extension image versions.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – Required.

• type (str) – Required.

• filter (str) – The filter to apply on the operation. Default value is None.

• top (int) – Default value is None.

• orderby (str) – Default value is None.

Keyword Arguments

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

Returns

list of VirtualMachineExtensionImage or the result of cls(response)

Return type

list[VirtualMachineExtensionImage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineExtensionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_extensions attribute.

begin_create_or_update(resource_group_name: str, vm_name: str, vm_extension_name: str, extension_parameters: _models.VirtualMachineExtension, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineExtension]

begin_create_or_update(resource_group_name: str, vm_name: str, vm_extension_name: str, extension_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineExtension]

The operation to create or update the extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine where the extension should be created or updated. Required.

• vm_extension_name (str) – The name of the virtual machine extension. Required.

• extension_parameters (VirtualMachineExtension or IO) – Parameters supplied to the Create Virtual Machine Extension operation. Is either a VirtualMachineExtension 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 VirtualMachineExtension or the result of cls(response)

Return type

LROPoller[VirtualMachineExtension]

Raises

HttpResponseError –

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

The operation to delete the extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine where the extension should be deleted. Required.

• vm_extension_name (str) – The name of the virtual machine extension. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, vm_name: str, vm_extension_name: str, extension_parameters: _models.VirtualMachineExtensionUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineExtension]

begin_update(resource_group_name: str, vm_name: str, vm_extension_name: str, extension_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineExtension]

The operation to update the extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine where the extension should be updated. Required.

• vm_extension_name (str) – The name of the virtual machine extension. Required.

• extension_parameters (VirtualMachineExtensionUpdate or IO) – Parameters supplied to the Update Virtual Machine Extension operation. Is either a VirtualMachineExtensionUpdate 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 VirtualMachineExtension or the result of cls(response)

Return type

LROPoller[VirtualMachineExtension]

Raises

HttpResponseError –

get(resource_group_name: str, vm_name: str, vm_extension_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineExtension

The operation to get the extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine containing the extension. Required.

• vm_extension_name (str) – The name of the virtual machine extension. Required.

• expand (str) – The expand expression to apply on the operation. Default value is None.

Keyword Arguments

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

Returns

VirtualMachineExtension or the result of cls(response)

Return type

VirtualMachineExtension

Raises

HttpResponseError –

list(resource_group_name: str, vm_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineExtensionsListResult

The operation to get all extensions of a Virtual Machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine containing the extension. Required.

• expand (str) – The expand expression to apply on the operation. Default value is None.

Keyword Arguments

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

Returns

VirtualMachineExtensionsListResult or the result of cls(response)

Return type

VirtualMachineExtensionsListResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineImagesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_images attribute.

get(location: str, publisher_name: str, offer: str, skus: str, version: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineImage

Gets a virtual machine image.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – A valid image publisher. Required.

• offer (str) – A valid image publisher offer. Required.

• skus (str) – A valid image SKU. Required.

• version (str) – A valid image SKU version. Required.

Keyword Arguments

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

Returns

VirtualMachineImage or the result of cls(response)

Return type

VirtualMachineImage

Raises

HttpResponseError –

list(location: str, publisher_name: str, offer: str, skus: str, expand: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → List[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineImageResource]

Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – A valid image publisher. Required.

• offer (str) – A valid image publisher offer. Required.

• skus (str) – A valid image SKU. Required.

• expand (str) – The expand expression to apply on the operation. Default value is None.

• top (int) – Default value is None.

• orderby (str) – Default value is None.

Keyword Arguments

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

Returns

list of VirtualMachineImageResource or the result of cls(response)

Return type

list[VirtualMachineImageResource]

Raises

HttpResponseError –

list_offers(location: str, publisher_name: str, **kwargs: Any) → List[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineImageResource]

Gets a list of virtual machine image offers for the specified location and publisher.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – A valid image publisher. Required.

Keyword Arguments

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

Returns

list of VirtualMachineImageResource or the result of cls(response)

Return type

list[VirtualMachineImageResource]

Raises

HttpResponseError –

list_publishers(location: str, **kwargs: Any) → List[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineImageResource]

Gets a list of virtual machine image publishers for the specified Azure location.

Parameters

location (str) – The name of a supported Azure region. Required.

Keyword Arguments

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

Returns

list of VirtualMachineImageResource or the result of cls(response)

Return type

list[VirtualMachineImageResource]

Raises

HttpResponseError –

list_skus(location: str, publisher_name: str, offer: str, **kwargs: Any) → List[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineImageResource]

Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.

Parameters

• location (str) – The name of a supported Azure region. Required.

• publisher_name (str) – A valid image publisher. Required.

• offer (str) – A valid image publisher offer. Required.

Keyword Arguments

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

Returns

list of VirtualMachineImageResource or the result of cls(response)

Return type

list[VirtualMachineImageResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineRunCommandsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_run_commands attribute.

get(location: str, command_id: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.RunCommandDocument

Gets specific run command for a subscription in a location.

Parameters

• location (str) – The location upon which run commands is queried. Required.

• command_id (str) – The command id. Required.

Keyword Arguments

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

Returns

RunCommandDocument or the result of cls(response)

Return type

RunCommandDocument

Raises

HttpResponseError –

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.RunCommandDocumentBase]

Lists all available run commands for a subscription in a location.

Parameters

location (str) – The location upon which run commands is queried. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RunCommandDocumentBase]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetExtensionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_scale_set_extensions attribute.

begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, extension_parameters: _models.VirtualMachineScaleSetExtension, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSetExtension]

begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, extension_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSetExtension]

The operation to create or update an extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set where the extension should be create or updated. Required.

• vmss_extension_name (str) – The name of the VM scale set extension. Required.

• extension_parameters (VirtualMachineScaleSetExtension or IO) – Parameters supplied to the Create VM scale set Extension operation. Is either a VirtualMachineScaleSetExtension 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 VirtualMachineScaleSetExtension or the result of cls(response)

Return type

LROPoller[VirtualMachineScaleSetExtension]

Raises

HttpResponseError –

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

The operation to delete the extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set where the extension should be deleted. Required.

• vmss_extension_name (str) – The name of the VM scale set extension. 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetExtension

The operation to get the extension.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set containing the extension. Required.

• vmss_extension_name (str) – The name of the VM scale set extension. Required.

• expand (str) – The expand expression to apply on the operation. Default value is None.

Keyword Arguments

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

Returns

VirtualMachineScaleSetExtension or the result of cls(response)

Return type

VirtualMachineScaleSetExtension

Raises

HttpResponseError –

list(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetExtension]

Gets a list of all extensions in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set containing the extension. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSetExtension]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetRollingUpgradesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_scale_set_rolling_upgrades attribute.

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

Cancels the current virtual machine scale set rolling upgrade.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. 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

LROPoller[None]

Raises

HttpResponseError –

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

Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. 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

LROPoller[None]

Raises

HttpResponseError –

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

Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. 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

LROPoller[None]

Raises

HttpResponseError –

get_latest(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.RollingUpgradeStatusInfo

Gets the status of the latest virtual machine scale set rolling upgrade.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

Keyword Arguments

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

Returns

RollingUpgradeStatusInfo or the result of cls(response)

Return type

RollingUpgradeStatusInfo

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetVMsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_scale_set_vms attribute.

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

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

Deletes a virtual machine from a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Performs maintenance on a virtual machine in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_power_off(resource_group_name: str, vm_scale_set_name: str, instance_id: str, skip_shutdown: bool = False, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. Required.

• skip_shutdown (bool) – The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified. Default value is False.

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

HttpResponseError –

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

Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_reimage(resource_group_name: str, vm_scale_set_name: str, instance_id: str, vm_scale_set_vm_reimage_input: Optional[_models.VirtualMachineScaleSetVMReimageParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_reimage(resource_group_name: str, vm_scale_set_name: str, instance_id: str, vm_scale_set_vm_reimage_input: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. Required.

• vm_scale_set_vm_reimage_input (VirtualMachineScaleSetVMReimageParameters or IO) – Parameters for the Reimaging Virtual machine in ScaleSet. Is either a VirtualMachineScaleSetVMReimageParameters type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_restart(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Restarts a virtual machine in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_run_command(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: _models.RunCommandInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RunCommandResult]

begin_run_command(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RunCommandResult]

Run command on a virtual machine in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. Required.

• parameters (RunCommandInput or IO) – Parameters supplied to the Run command operation. Is either a RunCommandInput type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’, ‘text/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 RunCommandResult or the result of cls(response)

Return type

LROPoller[RunCommandResult]

Raises

HttpResponseError –

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

Starts a virtual machine in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: _models.VirtualMachineScaleSetVM, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSetVM]

begin_update(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSetVM]

Updates a virtual machine of a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set where the extension should be create or updated. Required.

• instance_id (str) – The instance ID of the virtual machine. Required.

• parameters (VirtualMachineScaleSetVM or IO) – Parameters supplied to the Update Virtual Machine Scale Sets VM operation. Is either a VirtualMachineScaleSetVM 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 VirtualMachineScaleSetVM or the result of cls(response)

Return type

LROPoller[VirtualMachineScaleSetVM]

Raises

HttpResponseError –

get(resource_group_name: str, vm_scale_set_name: str, instance_id: str, expand: Literal[instanceView] = 'instanceView', **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetVM

Gets a virtual machine from a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. Required.

• expand (str) – The expand expression to apply on the operation. Known values are “instanceView” and None. Default value is “instanceView”.

Keyword Arguments

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

Returns

VirtualMachineScaleSetVM or the result of cls(response)

Return type

VirtualMachineScaleSetVM

Raises

HttpResponseError –

get_instance_view(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetVMInstanceView

Gets the status of a virtual machine from a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• instance_id (str) – The instance ID of the virtual machine. Required.

Keyword Arguments

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

Returns

VirtualMachineScaleSetVMInstanceView or the result of cls(response)

Return type

VirtualMachineScaleSetVMInstanceView

Raises

HttpResponseError –

list(resource_group_name: str, virtual_machine_scale_set_name: str, filter: Optional[str] = None, select: Optional[str] = None, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetVM]

Gets a list of all virtual machines in a VM scale sets.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• virtual_machine_scale_set_name (str) – The name of the VM scale set. Required.

• filter (str) – The filter to apply to the operation. Allowed values are ‘startswith(instanceView/statuses/code, ‘PowerState’) eq true’, ‘properties/latestModelApplied eq true’, ‘properties/latestModelApplied eq false’. Default value is None.

• select (str) – The list parameters. Allowed values are ‘instanceView’, ‘instanceView/statuses’. Default value is None.

• expand (str) – The expand expression to apply to the operation. Allowed values are ‘instanceView’. 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 VirtualMachineScaleSetVM or the result of cls(response)

Return type

ItemPaged[VirtualMachineScaleSetVM]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_scale_sets attribute.

begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, parameters: _models.VirtualMachineScaleSet, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSet]

begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSet]

Create or update a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set to create or update. Required.

• parameters (VirtualMachineScaleSet or IO) – The scale set object. Is either a VirtualMachineScaleSet 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 VirtualMachineScaleSet or the result of cls(response)

Return type

LROPoller[VirtualMachineScaleSet]

Raises

HttpResponseError –

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

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

Deletes a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceRequiredIDs, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_delete_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Deletes virtual machines in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceRequiredIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceRequiredIDs 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

LROPoller[None]

Raises

HttpResponseError –

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_power_off(resource_group_name: str, vm_scale_set_name: str, skip_shutdown: bool = False, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_power_off(resource_group_name: str, vm_scale_set_name: str, skip_shutdown: bool = False, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• skip_shutdown (bool) – The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified. Default value is False.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_redeploy(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_redeploy(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_reimage(resource_group_name: str, vm_scale_set_name: str, vm_scale_set_reimage_input: Optional[_models.VirtualMachineScaleSetReimageParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_reimage(resource_group_name: str, vm_scale_set_name: str, vm_scale_set_reimage_input: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don’t have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_scale_set_reimage_input (VirtualMachineScaleSetReimageParameters or IO) – Parameters for Reimaging VM ScaleSet. Is either a VirtualMachineScaleSetReimageParameters type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_restart(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_restart(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Restarts one or more virtual machines in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_start(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[_models.VirtualMachineScaleSetVMInstanceIDs] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_start(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Starts one or more virtual machines in a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceIDs type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, vm_scale_set_name: str, parameters: _models.VirtualMachineScaleSetUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSet]

begin_update(resource_group_name: str, vm_scale_set_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineScaleSet]

Update a VM scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set to create or update. Required.

• parameters (VirtualMachineScaleSetUpdate or IO) – The scale set object. Is either a VirtualMachineScaleSetUpdate 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 VirtualMachineScaleSet or the result of cls(response)

Return type

LROPoller[VirtualMachineScaleSet]

Raises

HttpResponseError –

begin_update_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceRequiredIDs, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_update_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• vm_instance_i_ds (VirtualMachineScaleSetVMInstanceRequiredIDs or IO) – A list of virtual machine instance IDs from the VM scale set. Is either a VirtualMachineScaleSetVMInstanceRequiredIDs 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

LROPoller[None]

Raises

HttpResponseError –

convert_to_single_placement_group(resource_group_name: str, vm_scale_set_name: str, parameters: _models.VMScaleSetConvertToSinglePlacementGroupInput, *, content_type: str = "'application/json'", **kwargs: Any) → None

convert_to_single_placement_group(resource_group_name: str, vm_scale_set_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Converts SinglePlacementGroup property to true for a existing virtual machine scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the virtual machine scale set to create or update. Required.

• parameters (VMScaleSetConvertToSinglePlacementGroupInput or IO) – The input object for ConvertToSinglePlacementGroup API. Is either a VMScaleSetConvertToSinglePlacementGroupInput 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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

force_recovery_service_fabric_platform_update_domain_walk(resource_group_name: str, vm_scale_set_name: str, platform_update_domain: int, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.RecoveryWalkResponse

Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

• platform_update_domain (int) – The platform update domain for which a manual recovery walk is requested. Required.

Keyword Arguments

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

Returns

RecoveryWalkResponse or the result of cls(response)

Return type

RecoveryWalkResponse

Raises

HttpResponseError –

get(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSet

Display information about a virtual machine scale set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

Keyword Arguments

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

Returns

VirtualMachineScaleSet or the result of cls(response)

Return type

VirtualMachineScaleSet

Raises

HttpResponseError –

get_instance_view(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetInstanceView

Gets the status of a VM scale set instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

Keyword Arguments

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

Returns

VirtualMachineScaleSetInstanceView or the result of cls(response)

Return type

VirtualMachineScaleSetInstanceView

Raises

HttpResponseError –

get_os_upgrade_history(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.UpgradeOperationHistoricalStatusInfo]

Gets list of OS upgrades on a VM scale set instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UpgradeOperationHistoricalStatusInfo]

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSet]

Gets a list of all VM scale sets under a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSet]

Raises

HttpResponseError –

list_all(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSet]

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSet]

Raises

HttpResponseError –

list_skus(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetSku]

Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_scale_set_name (str) – The name of the VM scale set. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSetSku]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineSizesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machine_sizes attribute.

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineSize]

This API is deprecated. Use Resources Skus.

Parameters

location (str) – The location upon which virtual-machine-sizes is queried. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineSize]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachinesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s virtual_machines attribute.

begin_capture(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineCaptureParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineCaptureResult]

begin_capture(resource_group_name: str, vm_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachineCaptureResult]

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• parameters (VirtualMachineCaptureParameters or IO) – Parameters supplied to the Capture Virtual Machine operation. Is either a VirtualMachineCaptureParameters 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 VirtualMachineCaptureResult or the result of cls(response)

Return type

LROPoller[VirtualMachineCaptureResult]

Raises

HttpResponseError –

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

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachine, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachine]

begin_create_or_update(resource_group_name: str, vm_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachine]

The operation to create or update a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• parameters (VirtualMachine or IO) – Parameters supplied to the Create Virtual Machine operation. Is either a VirtualMachine 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 VirtualMachine or the result of cls(response)

Return type

LROPoller[VirtualMachine]

Raises

HttpResponseError –

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

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

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

The operation to delete a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

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

The operation to perform maintenance on a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_power_off(resource_group_name: str, vm_name: str, skip_shutdown: bool = False, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• skip_shutdown (bool) – The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified. Default value is False.

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

HttpResponseError –

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

Shuts down the virtual machine, moves it to a new node, and powers it back on.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_reimage(resource_group_name: str, vm_name: str, parameters: Optional[_models.VirtualMachineReimageParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_reimage(resource_group_name: str, vm_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• parameters (VirtualMachineReimageParameters or IO) – Parameters supplied to the Reimage Virtual Machine operation. Is either a VirtualMachineReimageParameters type or a IO type. Default value is None.

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

LROPoller[None]

Raises

HttpResponseError –

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

The operation to restart a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_run_command(resource_group_name: str, vm_name: str, parameters: _models.RunCommandInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RunCommandResult]

begin_run_command(resource_group_name: str, vm_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RunCommandResult]

Run command on the VM.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• parameters (RunCommandInput or IO) – Parameters supplied to the Run command operation. Is either a RunCommandInput type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’, ‘text/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 RunCommandResult or the result of cls(response)

Return type

LROPoller[RunCommandResult]

Raises

HttpResponseError –

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

The operation to start a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachine]

begin_update(resource_group_name: str, vm_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualMachine]

The operation to update a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• parameters (VirtualMachineUpdate or IO) – Parameters supplied to the Update Virtual Machine operation. Is either a VirtualMachineUpdate 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 VirtualMachine or the result of cls(response)

Return type

LROPoller[VirtualMachine]

Raises

HttpResponseError –

generalize(resource_group_name: str, vm_name: str, **kwargs: Any) → None

Sets the state of the virtual machine to generalized.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, vm_name: str, expand: Literal[instanceView] = 'instanceView', **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachine

Retrieves information about the model view or the instance view of a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

• expand (str) – The expand expression to apply on the operation. Known values are “instanceView” and None. Default value is “instanceView”.

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

HttpResponseError –

instance_view(resource_group_name: str, vm_name: str, **kwargs: Any) → azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineInstanceView

Retrieves information about the run-time state of a virtual machine.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

Keyword Arguments

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

Returns

VirtualMachineInstanceView or the result of cls(response)

Return type

VirtualMachineInstanceView

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachine]

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

Parameters

resource_group_name (str) – The name of the resource group. Required.

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

ItemPaged[VirtualMachine]

Raises

HttpResponseError –

list_all(**kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachine]

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

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

ItemPaged[VirtualMachine]

Raises

HttpResponseError –

list_available_sizes(resource_group_name: str, vm_name: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineSize]

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• vm_name (str) – The name of the virtual machine. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineSize]

Raises

HttpResponseError –

list_by_location(location: str, **kwargs: Any) → Iterable[azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachine]

Gets all the virtual machines under the specified subscription for the specified location.

Parameters

location (str) – The location for which virtual machines under the subscription are queried. Required.

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

ItemPaged[VirtualMachine]

Raises

HttpResponseError –

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>