azure.mgmt.compute.v2019_03_01.operations module¶

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, availability_set_name: str, **kwargs: Any) → ’models.AvailabilitySet’[source]¶

Retrieves information about an availability set.

Parameters

resource_group_name (str) – The name of the resource group.
availability_set_name (str) – The name of the availability set.

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

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.AvailabilitySetListResult’][source]¶

Lists all availability sets in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AvailabilitySetListResult or the result of cls(response)
Return type: ItemPaged[AvailabilitySetListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_available_sizes(resource_group_name: str, availability_set_name: str, **kwargs: Any) → Iterable[‘models.VirtualMachineSizeListResult’][source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param availability_set_name

The name of the availability set.

type availability_set_name

str

keyword callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineSizeListResult]

raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(expand: Optional[str] = None, **kwargs: Any) → Iterable[‘models.AvailabilitySetListResult’][source]¶

Lists all availability sets in a subscription.

Parameters: expand (str) – The expand expression to apply to the operation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AvailabilitySetListResult or the result of cls(response)
Return type: ItemPaged[AvailabilitySetListResult]
Raises: ~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, availability_set_name: str, parameters: ‘models.AvailabilitySetUpdate’, **kwargs: Any) → ’models.AvailabilitySet’[source]¶

Update an availability set.

Parameters

resource_group_name (str) – The name of the resource group.
availability_set_name (str) – The name of the availability set.
parameters (AvailabilitySetUpdate) – Parameters supplied to the Update Availability Set operation.

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

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.DedicatedHostGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DedicatedHostGroupsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, host_group_name: str, parameters: ‘models.DedicatedHostGroup’, **kwargs: Any) → ’models.DedicatedHostGroup’[source]¶

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.
host_group_name (str) – The name of the dedicated host group.
parameters (DedicatedHostGroup) – Parameters supplied to the Create Dedicated Host Group.

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

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, host_group_name: str, **kwargs: Any) → None [source]¶

Delete a dedicated host group.

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.

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

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, host_group_name: str, **kwargs: Any) → ’models.DedicatedHostGroup’[source]¶

Retrieves information about a dedicated host group.

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.

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

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.DedicatedHostGroupListResult’][source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

keyword callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostGroupListResult]

raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(**kwargs: Any) → Iterable[‘models.DedicatedHostGroupListResult’][source]¶

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 callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostGroupListResult]

raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, host_group_name: str, parameters: ‘models.DedicatedHostGroupUpdate’, **kwargs: Any) → ’models.DedicatedHostGroup’[source]¶

Update an dedicated host group.

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.
parameters (DedicatedHostGroupUpdate) – Parameters supplied to the Update Dedicated Host Group operation.

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

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.DedicatedHostsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DedicatedHostsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: ‘models.DedicatedHost’, **kwargs: Any) → LROPoller[source]¶

Create or update a dedicated host .

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.
host_name (str) – The name of the dedicated host .
parameters (DedicatedHost) – Parameters supplied to the Create Dedicated Host.

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) – True for ARMPolling, False for no polling, or a polling object for 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

begin_delete(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) → LROPoller[source]¶

Delete a dedicated host.

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.
host_name (str) – The name of the dedicated host.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: ‘models.DedicatedHostUpdate’, **kwargs: Any) → LROPoller[source]¶

Update an dedicated host .

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.
host_name (str) – The name of the dedicated host .
parameters (DedicatedHostUpdate) – Parameters supplied to the Update Dedicated Host operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

get(resource_group_name: str, host_group_name: str, host_name: str, expand: Optional[str] = 'instanceView', **kwargs: Any) → ’models.DedicatedHost’[source]¶

Retrieves information about a dedicated host.

Parameters

resource_group_name (str) – The name of the resource group.
host_group_name (str) – The name of the dedicated host group.
host_name (str) – The name of the dedicated host.
expand (str) – The expand expression to apply on the operation.

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

~azure.core.exceptions.HttpResponseError

list_by_host_group(resource_group_name: str, host_group_name: str, **kwargs: Any) → Iterable[‘models.DedicatedHostListResult’][source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param host_group_name

The name of the dedicated host group.

type host_group_name

str

keyword callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostListResult]

raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.DisksOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DisksOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, disk_name: str, disk: ‘models.Disk’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

param disk

Disk object supplied in the body of the Put disk operation.

type disk

~azure.mgmt.compute.v2019_03_01.models.Disk

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either Disk or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.Disk]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, disk_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: ‘models.GrantAccessData’, **kwargs: Any) → LROPoller[source]¶

Grants access to a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

param grant_access_data

Access data object supplied in the body of the get disk access

operation.

type grant_access_data: ~azure.mgmt.compute.v2019_03_01.models.GrantAccessData
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either AccessUri or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.AccessUri]
raises ~azure.core.exceptions.HttpResponseError

begin_revoke_access(resource_group_name: str, disk_name: str, **kwargs: Any) → LROPoller[source]¶

Revokes access to a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, disk_name: str, disk: ‘models.DiskUpdate’, **kwargs: Any) → LROPoller[source]¶

Updates (patches) a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

param disk

Disk object supplied in the body of the Patch disk operation.

type disk

~azure.mgmt.compute.v2019_03_01.models.DiskUpdate

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either Disk or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.Disk]

raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, disk_name: str, **kwargs: Any) → ’models.Disk’[source]¶

Gets information about a disk.

Parameters

resource_group_name (str) – The name of the resource group.
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.

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

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.DiskList’][source]¶

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 DiskList or the result of cls(response)
Return type: ItemPaged[DiskList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.DiskList’][source]¶

Lists all the disks under a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DiskList or the result of cls(response)
Return type: ItemPaged[DiskList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.GalleriesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GalleriesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery: ‘models.Gallery’, **kwargs: Any) → LROPoller[source]¶

Create or update a Shared Image Gallery.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

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.

type gallery_name: str
param gallery: Parameters supplied to the create or update Shared Image Gallery operation.
type gallery: ~azure.mgmt.compute.v2019_03_01.models.Gallery
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either Gallery or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.Gallery]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, gallery_name: str, **kwargs: Any) → LROPoller[source]¶

Delete a Shared Image Gallery.

Parameters

resource_group_name (str) – The name of the resource group.
gallery_name (str) – The name of the Shared Image Gallery to be deleted.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

GalleryApplicationVersion

get(resource_group_name: str, gallery_name: str, **kwargs: Any) → ’models.Gallery’[source]¶

Retrieves information about a Shared Image Gallery.

Parameters

resource_group_name (str) – The name of the resource group.
gallery_name (str) – The name of the Shared Image Gallery.

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

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.GalleryList’][source]¶

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 GalleryList or the result of cls(response)
Return type: ItemPaged[GalleryList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.GalleryList’][source]¶

List galleries under a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either GalleryList or the result of cls(response)
Return type: ItemPaged[GalleryList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.GalleryApplicationVersionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GalleryApplicationVersionsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application_version_name: str, gallery_application_version: ‘models.GalleryApplicationVersion’, **kwargs: Any) → LROPoller[source]¶

Create or update a gallery Application Version.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Application Gallery in which the Application

Definition resides.

type gallery_name: str
param gallery_application_name: The name of the gallery Application Definition in which the

Application Version is to be created.

type gallery_application_name: str
param gallery_application_version_name: 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>.

type gallery_application_version_name

str

param gallery_application_version

Parameters supplied to the create or update gallery

Application Version operation.

type gallery_application_version: ~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersion
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either GalleryApplicationVersion or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersion]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application_version_name: str, **kwargs: Any) → LROPoller[source]¶

Delete a gallery Application Version.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Application Gallery in which the Application

Definition resides.

type gallery_name: str
param gallery_application_name: The name of the gallery Application Definition in which the

Application Version resides.

type gallery_application_name: str
param gallery_application_version_name: The name of the gallery Application Version to be

deleted.

type gallery_application_version_name: str
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either None or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[None]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application_version_name: str, expand: Optional[str] = 'ReplicationStatus', **kwargs: Any) → ’models.GalleryApplicationVersion’[source]¶

Retrieves information about a gallery Application Version.

Parameters

resource_group_name (str) – The name of the resource group.
gallery_name (str) – The name of the Shared Application Gallery in which the Application Definition resides.
gallery_application_name (str) – The name of the gallery Application Definition in which the Application Version resides.
gallery_application_version_name (str) – The name of the gallery Application Version to be retrieved.
expand (str) – The expand expression to apply on the operation.

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

Raises

~azure.core.exceptions.HttpResponseError

list_by_gallery_application(resource_group_name: str, gallery_name: str, gallery_application_name: str, **kwargs: Any) → Iterable[‘models.GalleryApplicationVersionList’][source]¶

List gallery Application Versions in a gallery Application Definition.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Application Gallery in which the Application

Definition resides.

type gallery_name: str
param gallery_application_name: The name of the Shared Application Gallery Application

Definition from which the Application Versions are to be listed.

type gallery_application_name: str
keyword callable cls: A custom type or function that will be passed the direct response
return: An iterator like instance of either GalleryApplicationVersionList or the result of cls(response)
rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersionList]
raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.GalleryApplicationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GalleryApplicationsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_application_name: str, gallery_application: ‘models.GalleryApplication’, **kwargs: Any) → LROPoller[source]¶

Create or update a gallery Application Definition.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Application Gallery in which the Application

Definition is to be created.

type gallery_name: str
param gallery_application_name: 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.

type gallery_application_name

str

param gallery_application

Parameters supplied to the create or update gallery Application

operation.

type gallery_application: ~azure.mgmt.compute.v2019_03_01.models.GalleryApplication
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either GalleryApplication or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.GalleryApplication]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, gallery_name: str, gallery_application_name: str, **kwargs: Any) → LROPoller[source]¶

Delete a gallery Application.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Application Gallery in which the Application

Definition is to be deleted.

type gallery_name: str
param gallery_application_name: The name of the gallery Application Definition to be deleted.
type gallery_application_name: str
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either None or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[None]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, gallery_name: str, gallery_application_name: str, **kwargs: Any) → ’models.GalleryApplication’[source]¶

Retrieves information about a gallery Application Definition.

Parameters

resource_group_name (str) – The name of the resource group.
gallery_name (str) – The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
gallery_application_name (str) – The name of the gallery Application Definition to be retrieved.

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

~azure.core.exceptions.HttpResponseError

list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs: Any) → Iterable[‘models.GalleryApplicationList’][source]¶

List gallery Application Definitions in a gallery.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Application Gallery from which Application

Definitions are to be listed.

type gallery_name: str
keyword callable cls: A custom type or function that will be passed the direct response
return: An iterator like instance of either GalleryApplicationList or the result of cls(response)
rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationList]
raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.GalleryImageVersionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GalleryImageVersionsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, gallery_image_version: ‘models.GalleryImageVersion’, **kwargs: Any) → LROPoller[source]¶

Create or update a gallery Image Version.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Image Gallery in which the Image Definition

resides.

type gallery_name: str
param gallery_image_name: The name of the gallery Image Definition in which the Image Version

is to be created.

type gallery_image_name: str
param gallery_image_version_name: 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>.

type gallery_image_version_name

str

param gallery_image_version

Parameters supplied to the create or update gallery Image Version

operation.

type gallery_image_version: ~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersion
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either GalleryImageVersion or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersion]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, **kwargs: Any) → LROPoller[source]¶

Delete a gallery Image Version.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Image Gallery in which the Image Definition

resides.

type gallery_name: str
param gallery_image_name: The name of the gallery Image Definition in which the Image Version

resides.

type gallery_image_name: str
param gallery_image_version_name: The name of the gallery Image Version to be deleted.
type gallery_image_version_name: str
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either None or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[None]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, expand: Optional[str] = 'ReplicationStatus', **kwargs: Any) → ’models.GalleryImageVersion’[source]¶

Retrieves information about a gallery Image Version.

Parameters

resource_group_name (str) – The name of the resource group.
gallery_name (str) – The name of the Shared Image Gallery in which the Image Definition resides.
gallery_image_name (str) – The name of the gallery Image Definition in which the Image Version resides.
gallery_image_version_name (str) – The name of the gallery Image Version to be retrieved.
expand (str) – The expand expression to apply on the operation.

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

~azure.core.exceptions.HttpResponseError

list_by_gallery_image(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) → Iterable[‘models.GalleryImageVersionList’][source]¶

List gallery Image Versions in a gallery Image Definition.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Image Gallery in which the Image Definition

resides.

type gallery_name: str
param gallery_image_name: The name of the Shared Image Gallery Image Definition from which the

Image Versions are to be listed.

type gallery_image_name: str
keyword callable cls: A custom type or function that will be passed the direct response
return: An iterator like instance of either GalleryImageVersionList or the result of cls(response)
rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersionList]
raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.GalleryImagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GalleryImagesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image: ‘models.GalleryImage’, **kwargs: Any) → LROPoller[source]¶

Create or update a gallery Image Definition.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Image Gallery in which the Image Definition is to

be created.

type gallery_name: str
param gallery_image_name: 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.

type gallery_image_name

str

param gallery_image

Parameters supplied to the create or update gallery image operation.

type gallery_image

~azure.mgmt.compute.v2019_03_01.models.GalleryImage

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either GalleryImage or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.GalleryImage]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) → LROPoller[source]¶

Delete a gallery image.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Image Gallery in which the Image Definition is to

be deleted.

type gallery_name: str
param gallery_image_name: The name of the gallery Image Definition to be deleted.
type gallery_image_name: str
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either None or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[None]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) → ’models.GalleryImage’[source]¶

Retrieves information about a gallery Image Definition.

Parameters

resource_group_name (str) – The name of the resource group.
gallery_name (str) – The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
gallery_image_name (str) – The name of the gallery Image Definition to be retrieved.

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

~azure.core.exceptions.HttpResponseError

list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs: Any) → Iterable[‘models.GalleryImageList’][source]¶

List gallery Image Definitions in a gallery.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param gallery_name

The name of the Shared Image Gallery from which Image Definitions are to

be listed.

type gallery_name: str
keyword callable cls: A custom type or function that will be passed the direct response
return: An iterator like instance of either GalleryImageList or the result of cls(response)
rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.GalleryImageList]
raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.ImagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ImagesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, image_name: str, parameters: ‘models.Image’, **kwargs: Any) → LROPoller[source]¶

Create or update an image.

Parameters

resource_group_name (str) – The name of the resource group.
image_name (str) – The name of the image.
parameters (Image) – Parameters supplied to the Create Image operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

begin_delete(resource_group_name: str, image_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes an Image.

Parameters

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

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_update(resource_group_name: str, image_name: str, parameters: ‘models.ImageUpdate’, **kwargs: Any) → LROPoller[source]¶

Update an image.

Parameters

resource_group_name (str) – The name of the resource group.
image_name (str) – The name of the image.
parameters (ImageUpdate) – Parameters supplied to the Update Image operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

get(resource_group_name: str, image_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.Image’[source]¶

Gets an image.

Parameters

resource_group_name (str) – The name of the resource group.
image_name (str) – The name of the image.
expand (str) – The expand expression to apply on the operation.

Keyword Arguments

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

Returns

Image, or the result of cls(response)

Return type

Image

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.ImageListResult’][source]¶

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 callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.ImageListResult]

raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ImageListResult’][source]¶

Gets the list of images under a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ImageListResult or the result of cls(response)
Return type: ItemPaged[ImageListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.LogAnalyticsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LogAnalyticsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_export_request_rate_by_interval(location: str, parameters: ‘models.RequestRateByIntervalInput’, **kwargs: Any) → LROPoller[source]¶

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

param location

The location upon which virtual-machine-sizes is queried.

type location

str

param parameters

Parameters supplied to the LogAnalytics getRequestRateByInterval Api.

type parameters

~azure.mgmt.compute.v2019_03_01.models.RequestRateByIntervalInput

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either LogAnalyticsOperationResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.LogAnalyticsOperationResult]

raises ~azure.core.exceptions.HttpResponseError

begin_export_throttled_requests(location: str, parameters: ‘models.LogAnalyticsInputBase’, **kwargs: Any) → LROPoller[source]¶

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

param location

The location upon which virtual-machine-sizes is queried.

type location

str

param parameters

Parameters supplied to the LogAnalytics getThrottledRequests Api.

type parameters

~azure.mgmt.compute.v2019_03_01.models.LogAnalyticsInputBase

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either LogAnalyticsOperationResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.LogAnalyticsOperationResult]

raises ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.Operations(client, config, serializer, deserializer)[source]¶

Bases: object

Operations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘models.ComputeOperationListResult’][source]¶

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 ComputeOperationListResult or the result of cls(response)
Return type: ItemPaged[ComputeOperationListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.ProximityPlacementGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProximityPlacementGroupsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, proximity_placement_group_name: str, parameters: ‘models.ProximityPlacementGroup’, **kwargs: Any) → ’models.ProximityPlacementGroup’[source]¶

Create or update a proximity placement group.

Parameters

resource_group_name (str) – The name of the resource group.
proximity_placement_group_name (str) – The name of the proximity placement group.
parameters (ProximityPlacementGroup) – Parameters supplied to the Create Proximity Placement Group operation.

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

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, proximity_placement_group_name: str, **kwargs: Any) → None [source]¶

Delete a proximity placement group.

Parameters

resource_group_name (str) – The name of the resource group.
proximity_placement_group_name (str) – The name of the proximity placement group.

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

VirtualMachineExtensionImage

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, proximity_placement_group_name: str, **kwargs: Any) → ’models.ProximityPlacementGroup’[source]¶

Retrieves information about a proximity placement group .

Parameters

resource_group_name (str) – The name of the resource group.
proximity_placement_group_name (str) – The name of the proximity placement group.

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

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ProximityPlacementGroupListResult’][source]¶

Lists all proximity placement groups in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ProximityPlacementGroupListResult or the result of cls(response)
Return type: ItemPaged[ProximityPlacementGroupListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_subscription(**kwargs: Any) → Iterable[‘models.ProximityPlacementGroupListResult’][source]¶

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 ProximityPlacementGroupListResult or the result of cls(response)
Return type: ItemPaged[ProximityPlacementGroupListResult]
Raises: ~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, proximity_placement_group_name: str, parameters: ‘models.UpdateResource’, **kwargs: Any) → ’models.ProximityPlacementGroup’[source]¶

Update a proximity placement group.

Parameters

resource_group_name (str) – The name of the resource group.
proximity_placement_group_name (str) – The name of the proximity placement group.
parameters (UpdateResource) – Parameters supplied to the Update Proximity Placement Group operation.

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

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SnapshotsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: ‘models.Snapshot’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

param snapshot

Snapshot object supplied in the body of the Put disk operation.

type snapshot

~azure.mgmt.compute.v2019_03_01.models.Snapshot

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either Snapshot or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.Snapshot]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, snapshot_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: ‘models.GrantAccessData’, **kwargs: Any) → LROPoller[source]¶

Grants access to a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

param grant_access_data

Access data object supplied in the body of the get snapshot access

operation.

type grant_access_data: ~azure.mgmt.compute.v2019_03_01.models.GrantAccessData
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either AccessUri or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.AccessUri]
raises ~azure.core.exceptions.HttpResponseError

begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs: Any) → LROPoller[source]¶

Revokes access to a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, snapshot_name: str, snapshot: ‘models.SnapshotUpdate’, **kwargs: Any) → LROPoller[source]¶

Updates (patches) a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

param snapshot

Snapshot object supplied in the body of the Patch snapshot operation.

type snapshot

~azure.mgmt.compute.v2019_03_01.models.SnapshotUpdate

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either Snapshot or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.Snapshot]

raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, snapshot_name: str, **kwargs: Any) → ’models.Snapshot’[source]¶

Gets information about a snapshot.

Parameters

resource_group_name (str) – The name of the resource group.
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.

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

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.SnapshotList’][source]¶

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 SnapshotList or the result of cls(response)
Return type: ItemPaged[SnapshotList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.SnapshotList’][source]¶

Lists snapshots under a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SnapshotList or the result of cls(response)
Return type: ItemPaged[SnapshotList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.UsageOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UsageOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(location: str, **kwargs: Any) → Iterable[‘models.ListUsagesResult’][source]¶

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

param location

The location for which resource usage is queried.

type location

str

keyword callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.ListUsagesResult]

raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineExtensionImagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineExtensionImagesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(location: str, publisher_name: str, type: str, version: str, **kwargs: Any) → ’models.VirtualMachineExtensionImage’[source]¶

Gets a virtual machine extension image.

Parameters

location (str) – The name of a supported Azure region.
publisher_name (str) –
type (str) –
version (str) –

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

Raises

~azure.core.exceptions.HttpResponseError

list_types(location: str, publisher_name: str, **kwargs: Any) → List[‘models.VirtualMachineExtensionImage’][source]¶

Gets a list of virtual machine extension image types.

Parameters

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

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

~azure.core.exceptions.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[‘models.VirtualMachineExtensionImage’][source]¶

Gets a list of virtual machine extension image versions.

Parameters

location (str) – The name of a supported Azure region.
publisher_name (str) –
type (str) –
filter (str) – The filter to apply on the operation.
top (int) –
orderby (str) –

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

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineExtensionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineExtensionsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, vm_name: str, vm_extension_name: str, extension_parameters: ‘models.VirtualMachineExtension’, **kwargs: Any) → LROPoller[source]¶

The operation to create or update the extension.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_name

The name of the virtual machine where the extension should be created or

updated.

type vm_name: str
param vm_extension_name: The name of the virtual machine extension.
type vm_extension_name: str
param extension_parameters: Parameters supplied to the Create Virtual Machine Extension

operation.

type extension_parameters: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualMachineExtension or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, vm_name: str, vm_extension_name: str, **kwargs: Any) → LROPoller[source]¶

The operation to delete the extension.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine where the extension should be deleted.
vm_extension_name (str) – The name of the virtual machine extension.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

VirtualMachineExtensionsListResult

begin_update(resource_group_name: str, vm_name: str, vm_extension_name: str, extension_parameters: ‘models.VirtualMachineExtensionUpdate’, **kwargs: Any) → LROPoller[source]¶

The operation to update the extension.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_name

The name of the virtual machine where the extension should be updated.

type vm_name

str

param vm_extension_name

The name of the virtual machine extension.

type vm_extension_name

str

param extension_parameters

Parameters supplied to the Update Virtual Machine Extension

operation.

type extension_parameters: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionUpdate
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualMachineExtension or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, vm_name: str, vm_extension_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.VirtualMachineExtension’[source]¶

The operation to get the extension.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine containing the extension.
vm_extension_name (str) – The name of the virtual machine extension.
expand (str) – The expand expression to apply on the operation.

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

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, vm_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.VirtualMachineExtensionsListResult’[source]¶

The operation to get all extensions of a Virtual Machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine containing the extension.
expand (str) – The expand expression to apply on the operation.

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

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineImagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineImagesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(location: str, publisher_name: str, offer: str, skus: str, version: str, **kwargs: Any) → ’models.VirtualMachineImage’[source]¶

Gets a virtual machine image.

Parameters

location (str) – The name of a supported Azure region.
publisher_name (str) – A valid image publisher.
offer (str) – A valid image publisher offer.
skus (str) – A valid image SKU.
version (str) – A valid image SKU version.

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

~azure.core.exceptions.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[‘models.VirtualMachineImageResource’][source]¶

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.
publisher_name (str) – A valid image publisher.
offer (str) – A valid image publisher offer.
skus (str) – A valid image SKU.
expand (str) – The expand expression to apply on the operation.
top (int) –
orderby (str) –

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

~azure.core.exceptions.HttpResponseError

list_offers(location: str, publisher_name: str, **kwargs: Any) → List[‘models.VirtualMachineImageResource’][source]¶

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

Parameters

location (str) – The name of a supported Azure region.
publisher_name (str) – A valid image publisher.

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

~azure.core.exceptions.HttpResponseError

list_publishers(location: str, **kwargs: Any) → List[‘models.VirtualMachineImageResource’][source]¶

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

Parameters: location (str) – The name of a supported Azure region.
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: ~azure.core.exceptions.HttpResponseError

list_skus(location: str, publisher_name: str, offer: str, **kwargs: Any) → List[‘models.VirtualMachineImageResource’][source]¶

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.
publisher_name (str) – A valid image publisher.
offer (str) – A valid image publisher offer.

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

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineRunCommandsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineRunCommandsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(location: str, command_id: str, **kwargs: Any) → ’models.RunCommandDocument’[source]¶

Gets specific run command for a subscription in a location.

Parameters

location (str) – The location upon which run commands is queried.
command_id (str) – The command id.

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

~azure.core.exceptions.HttpResponseError

list(location: str, **kwargs: Any) → Iterable[‘models.RunCommandListResult’][source]¶

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

Parameters: location (str) – The location upon which run commands is queried.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RunCommandListResult or the result of cls(response)
Return type: ItemPaged[RunCommandListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetExtensionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineScaleSetExtensionsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, extension_parameters: ‘models.VirtualMachineScaleSetExtension’, **kwargs: Any) → LROPoller[source]¶

The operation to create or update an extension.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set where the extension should be create or

updated.

type vm_scale_set_name: str
param vmss_extension_name: The name of the VM scale set extension.
type vmss_extension_name: str
param extension_parameters: Parameters supplied to the Create VM scale set Extension

operation.

type extension_parameters: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtension
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualMachineScaleSetExtension or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtension]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, **kwargs: Any) → LROPoller[source]¶

The operation to delete the extension.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set where the extension should be deleted.
vmss_extension_name (str) – The name of the VM scale set extension.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

VirtualMachineScaleSetExtension

get(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.VirtualMachineScaleSetExtension’[source]¶

The operation to get the extension.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set containing the extension.
vmss_extension_name (str) – The name of the VM scale set extension.
expand (str) – The expand expression to apply on the operation.

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

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → Iterable[‘models.VirtualMachineScaleSetExtensionListResult’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set containing the extension.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSetExtensionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetRollingUpgradesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineScaleSetRollingUpgradesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_cancel(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → LROPoller[source]¶

Cancels the current virtual machine scale set rolling upgrade.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_start_extension_upgrade(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_start_os_upgrade(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

get_latest(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → ’models.RollingUpgradeStatusInfo’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.

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

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetVMsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineScaleSetVMsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param instance_id

The instance ID of the virtual machine.

type instance_id

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

Deletes a virtual machine from a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_power_off(resource_group_name: str, vm_scale_set_name: str, instance_id: str, skip_shutdown: Optional[bool] = False, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param instance_id

The instance ID of the virtual machine.

type instance_id

str

param skip_shutdown

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.

type skip_shutdown

bool

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_redeploy(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param instance_id

The instance ID of the virtual machine.

type instance_id

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_reimage(resource_group_name: str, vm_scale_set_name: str, instance_id: str, vm_scale_set_vm_reimage_input: Optional[‘models.VirtualMachineReimageParameters’] = None, **kwargs: Any) → LROPoller[source]¶

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.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.
vm_scale_set_vm_reimage_input (VirtualMachineReimageParameters) – Parameters for the Reimaging Virtual machine in ScaleSet.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param instance_id

The instance ID of the virtual machine.

type instance_id

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_restart(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

Restarts a virtual machine in a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

LROPoller[RunCommandResult]

begin_run_command(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: ‘models.RunCommandInput’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.
parameters (RunCommandInput) – Parameters supplied to the Run command operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

Raises

begin_start(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → LROPoller[source]¶

Starts a virtual machine in a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

VirtualMachineScaleSetVMInstanceView

begin_update(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: ‘models.VirtualMachineScaleSetVM’, **kwargs: Any) → LROPoller[source]¶

Updates a virtual machine of a VM scale set.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set where the extension should be create or

updated.

type vm_scale_set_name: str
param instance_id: The instance ID of the virtual machine.
type instance_id: str
param parameters: Parameters supplied to the Update Virtual Machine Scale Sets VM operation.
type parameters: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVM
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualMachineScaleSetVM or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVM]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, vm_scale_set_name: str, instance_id: str, expand: Optional[str] = 'instanceView', **kwargs: Any) → ’models.VirtualMachineScaleSetVM’[source]¶

Gets a virtual machine from a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.
expand (str) – The expand expression to apply on the operation.

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

~azure.core.exceptions.HttpResponseError

get_instance_view(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) → ’models.VirtualMachineScaleSetVMInstanceView’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
instance_id (str) – The instance ID of the virtual machine.

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

Raises

~azure.core.exceptions.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[‘models.VirtualMachineScaleSetVMListResult’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the VM scale set.
filter (str) – The filter to apply to the operation.
select (str) – The list parameters.
expand (str) – The expand expression to apply to the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSetVMListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineScaleSetsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineScaleSetsOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, parameters: ‘models.VirtualMachineScaleSet’, **kwargs: Any) → LROPoller[source]¶

Create or update a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set to create or update.
parameters (VirtualMachineScaleSet) – The scale set object.

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) – True for ARMPolling, False for no polling, or a polling object for 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

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param vm_instance_i_ds

A list of virtual machine instance IDs from the VM scale set.

type vm_instance_i_ds

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMInstanceIDs

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_delete_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: ‘models.VirtualMachineScaleSetVMInstanceRequiredIDs’, **kwargs: Any) → LROPoller[source]¶

Deletes virtual machines in a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
vm_instance_i_ds (VirtualMachineScaleSetVMInstanceRequiredIDs) – A list of virtual machine instance IDs from the VM scale set.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param vm_instance_i_ds

A list of virtual machine instance IDs from the VM scale set.

type vm_instance_i_ds

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMInstanceIDs

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_power_off(resource_group_name: str, vm_scale_set_name: str, skip_shutdown: Optional[bool] = False, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param skip_shutdown

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.

type skip_shutdown

bool

param vm_instance_i_ds

A list of virtual machine instance IDs from the VM scale set.

type vm_instance_i_ds

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMInstanceIDs

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_redeploy(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param vm_instance_i_ds

A list of virtual machine instance IDs from the VM scale set.

type vm_instance_i_ds

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMInstanceIDs

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_reimage(resource_group_name: str, vm_scale_set_name: str, vm_scale_set_reimage_input: Optional[‘models.VirtualMachineScaleSetReimageParameters’] = None, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param vm_scale_set_reimage_input

Parameters for Reimaging VM ScaleSet.

type vm_scale_set_reimage_input

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetReimageParameters

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

param vm_instance_i_ds

A list of virtual machine instance IDs from the VM scale set.

type vm_instance_i_ds

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMInstanceIDs

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_restart(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs) – A list of virtual machine instance IDs from the VM scale set.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_start(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: Optional[‘models.VirtualMachineScaleSetVMInstanceIDs’] = None, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.
vm_instance_i_ds (VirtualMachineScaleSetVMInstanceIDs) – A list of virtual machine instance IDs from the VM scale set.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

LROPoller[VirtualMachineScaleSet]

begin_update(resource_group_name: str, vm_scale_set_name: str, parameters: ‘models.VirtualMachineScaleSetUpdate’, **kwargs: Any) → LROPoller[source]¶

Update a VM scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set to create or update.
parameters (VirtualMachineScaleSetUpdate) – The scale set object.

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) – True for ARMPolling, False for no polling, or a polling object for 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

Raises

begin_update_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: ‘models.VirtualMachineScaleSetVMInstanceRequiredIDs’, **kwargs: Any) → LROPoller[source]¶

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.
vm_scale_set_name (str) – The name of the VM scale set.
vm_instance_i_ds (VirtualMachineScaleSetVMInstanceRequiredIDs) – A list of virtual machine instance IDs from the VM scale set.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

convert_to_single_placement_group(resource_group_name: str, vm_scale_set_name: str, parameters: ‘models.VMScaleSetConvertToSinglePlacementGroupInput’, **kwargs: Any) → None [source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the virtual machine scale set to create or update.
parameters (VMScaleSetConvertToSinglePlacementGroupInput) – The input object for ConvertToSinglePlacementGroup API.

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

VirtualMachineScaleSetInstanceView

Raises

~azure.core.exceptions.HttpResponseError

force_recovery_service_fabric_platform_update_domain_walk(resource_group_name: str, vm_scale_set_name: str, platform_update_domain: int, **kwargs: Any) → ’models.RecoveryWalkResponse’[source]¶

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.
vm_scale_set_name (str) – The name of the VM scale set.
platform_update_domain (int) – The platform update domain for which a manual recovery walk is requested.

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

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → ’models.VirtualMachineScaleSet’[source]¶

Display information about a virtual machine scale set.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.

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

~azure.core.exceptions.HttpResponseError

get_instance_view(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → ’models.VirtualMachineScaleSetInstanceView’[source]¶

Gets the status of a VM scale set instance.

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.

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

Raises

~azure.core.exceptions.HttpResponseError

get_os_upgrade_history(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → Iterable[‘models.VirtualMachineScaleSetListOSUpgradeHistory’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
vm_scale_set_name (str) – The name of the VM scale set.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualMachineScaleSetListOSUpgradeHistory]

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.VirtualMachineScaleSetListResult’][source]¶

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

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either VirtualMachineScaleSetListResult or the result of cls(response)
Return type: ItemPaged[VirtualMachineScaleSetListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.VirtualMachineScaleSetListWithLinkResult’][source]¶

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 callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetListWithLinkResult]

raises

~azure.core.exceptions.HttpResponseError

list_skus(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) → Iterable[‘models.VirtualMachineScaleSetListSkusResult’][source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_scale_set_name

The name of the VM scale set.

type vm_scale_set_name

str

keyword callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetListSkusResult]

raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachineSizesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachineSizesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(location: str, **kwargs: Any) → Iterable[‘models.VirtualMachineSizeListResult’][source]¶

This API is deprecated. Use Resources Skus.

param location

The location upon which virtual-machine-sizes is queried.

type location

str

keyword callable cls

A custom type or function that will be passed the direct response

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineSizeListResult]

raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2019_03_01.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2019_03_01/models/__init__.py'>¶

class azure.mgmt.compute.v2019_03_01.operations.VirtualMachinesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualMachinesOperations operations.

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

Variables

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

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_capture(resource_group_name: str, vm_name: str, parameters: ‘models.VirtualMachineCaptureParameters’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_name

The name of the virtual machine.

type vm_name

str

param parameters

Parameters supplied to the Capture Virtual Machine operation.

type parameters

~azure.mgmt.compute.v2019_03_01.models.VirtualMachineCaptureParameters

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either VirtualMachineCaptureResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineCaptureResult]

raises ~azure.core.exceptions.HttpResponseError

begin_convert_to_managed_disks(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_name

The name of the virtual machine.

type vm_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_create_or_update(resource_group_name: str, vm_name: str, parameters: ‘models.VirtualMachine’, **kwargs: Any) → LROPoller[source]¶

The operation to create or update a virtual machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.
parameters (VirtualMachine) – Parameters supplied to the Create Virtual Machine operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

begin_deallocate(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_name

The name of the virtual machine.

type vm_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

The operation to delete a virtual machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_perform_maintenance(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

The operation to perform maintenance on a virtual machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_power_off(resource_group_name: str, vm_name: str, skip_shutdown: Optional[bool] = False, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param vm_name

The name of the virtual machine.

type vm_name

str

param skip_shutdown

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.

type skip_shutdown

bool

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either None or the result of cls(response)

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_redeploy(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

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

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_reimage(resource_group_name: str, vm_name: str, parameters: Optional[‘models.VirtualMachineReimageParameters’] = None, **kwargs: Any) → LROPoller[source]¶

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.
vm_name (str) – The name of the virtual machine.
parameters (VirtualMachineReimageParameters) – Parameters supplied to the Reimage Virtual Machine operation.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

begin_restart(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

The operation to restart a virtual machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

LROPoller[RunCommandResult]

begin_run_command(resource_group_name: str, vm_name: str, parameters: ‘models.RunCommandInput’, **kwargs: Any) → LROPoller[source]¶

Run command on the VM.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.
parameters (RunCommandInput) – Parameters supplied to the Run command operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

Raises

begin_start(resource_group_name: str, vm_name: str, **kwargs: Any) → LROPoller[source]¶

The operation to start a virtual machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.

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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

LROPoller[VirtualMachine]

begin_update(resource_group_name: str, vm_name: str, parameters: ‘models.VirtualMachineUpdate’, **kwargs: Any) → LROPoller[source]¶

The operation to update a virtual machine.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.
parameters (VirtualMachineUpdate) – Parameters supplied to the Update Virtual Machine operation.

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) – True for ARMPolling, False for no polling, or a polling object for 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

Raises

generalize(resource_group_name: str, vm_name: str, **kwargs: Any) → None [source]¶

Sets the state of the virtual machine to generalized.

Parameters

resource_group_name (str) – The name of the resource group.
vm_name (str) – The name of the virtual machine.

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