azure.mgmt.vmwarecloudsimple.operations module

class azure.mgmt.vmwarecloudsimple.operations.Operations(client, config, serializer, deserializer)

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

get(region_id, operation_id, custom_headers=None, raw=False, **operation_config)

Implements get of async operation.

Return an async operation.

Parameters

• region_id (str) – The region Id (westus, eastus)

• operation_id (str) – operation id

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OperationResource or ClientRawResponse if raw=true

Return type

OperationResource or ClientRawResponse

Raises

CSRPErrorException

list(custom_headers=None, raw=False, **operation_config)

Implements list of available operations.

Return list of operations.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of AvailableOperation

Return type

AvailableOperationPaged[AvailableOperation]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.DedicatedCloudNodesOperations(client, config, serializer, deserializer)

Bases: object

DedicatedCloudNodesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

create_or_update(resource_group_name, dedicated_cloud_node_name, dedicated_cloud_node_request, custom_headers=None, raw=False, polling=True, **operation_config)

Implements dedicated cloud node PUT method.

Returns dedicated cloud node by its name.

Parameters

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

• dedicated_cloud_node_name (str) – dedicated cloud node name

• dedicated_cloud_node_request (DedicatedCloudNode) – Create Dedicated Cloud Node request

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns DedicatedCloudNode or ClientRawResponse<DedicatedCloudNode> if raw==True

Return type

AzureOperationPoller[DedicatedCloudNode] or AzureOperationPoller[ClientRawResponse[DedicatedCloudNode]]

Raises

CSRPErrorException

delete(resource_group_name, dedicated_cloud_node_name, custom_headers=None, raw=False, **operation_config)

Implements dedicated cloud node DELETE method.

Delete dedicated cloud node.

Parameters

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

• dedicated_cloud_node_name (str) – dedicated cloud node name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CSRPErrorException

get(resource_group_name, dedicated_cloud_node_name, custom_headers=None, raw=False, **operation_config)

Implements dedicated cloud node GET method.

Returns dedicated cloud node.

Parameters

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

• dedicated_cloud_node_name (str) – dedicated cloud node name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DedicatedCloudNode or ClientRawResponse if raw=true

Return type

DedicatedCloudNode or ClientRawResponse

Raises

CSRPErrorException

list_by_resource_group(resource_group_name, filter=None, top=None, skip_token=None, custom_headers=None, raw=False, **operation_config)

Implements list of dedicated cloud nodes within RG method.

Returns list of dedicate cloud nodes within resource group.

Parameters

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

• filter (str) – The filter to apply on the list operation

• top (int) – The maximum number of record sets to return

• skip_token (str) – to be used by nextLink implementation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of DedicatedCloudNode

Return type

DedicatedCloudNodePaged[DedicatedCloudNode]

Raises

CSRPErrorException

list_by_subscription(filter=None, top=None, skip_token=None, custom_headers=None, raw=False, **operation_config)

Implements list of dedicated cloud nodes within subscription method.

Returns list of dedicate cloud nodes within subscription.

Parameters

• filter (str) – The filter to apply on the list operation

• top (int) – The maximum number of record sets to return

• skip_token (str) – to be used by nextLink implementation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of DedicatedCloudNode

Return type

DedicatedCloudNodePaged[DedicatedCloudNode]

Raises

CSRPErrorException

update(resource_group_name, dedicated_cloud_node_name, tags=None, custom_headers=None, raw=False, **operation_config)

Implements dedicated cloud node PATCH method.

Patches dedicated node properties.

Parameters

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

• dedicated_cloud_node_name (str) – dedicated cloud node name

• tags (dict[str, str]) – The tags key:value pairs

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DedicatedCloudNode or ClientRawResponse if raw=true

Return type

DedicatedCloudNode or ClientRawResponse

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.DedicatedCloudServicesOperations(client, config, serializer, deserializer)

Bases: object

DedicatedCloudServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

create_or_update(resource_group_name, dedicated_cloud_service_name, dedicated_cloud_service_request, custom_headers=None, raw=False, **operation_config)

Implements dedicated cloud service PUT method.

Create dedicate cloud service.

Parameters

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

• dedicated_cloud_service_name (str) – dedicated cloud Service name

• dedicated_cloud_service_request (DedicatedCloudService) – Create Dedicated Cloud Service request

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DedicatedCloudService or ClientRawResponse if raw=true

Return type

DedicatedCloudService or ClientRawResponse

Raises

CSRPErrorException

delete(resource_group_name, dedicated_cloud_service_name, custom_headers=None, raw=False, polling=True, **operation_config)

Implements dedicatedCloudService DELETE method.

Delete dedicate cloud service.

Parameters

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

• dedicated_cloud_service_name (str) – dedicated cloud service name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CSRPErrorException

get(resource_group_name, dedicated_cloud_service_name, custom_headers=None, raw=False, **operation_config)

Implements dedicatedCloudService GET method.

Returns Dedicate Cloud Service.

Parameters

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

• dedicated_cloud_service_name (str) – dedicated cloud Service name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DedicatedCloudService or ClientRawResponse if raw=true

Return type

DedicatedCloudService or ClientRawResponse

Raises

CSRPErrorException

list_by_resource_group(resource_group_name, filter=None, top=None, skip_token=None, custom_headers=None, raw=False, **operation_config)

Implements list of dedicatedCloudService objects within RG method.

Returns list of dedicated cloud services within a resource group.

Parameters

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

• filter (str) – The filter to apply on the list operation

• top (int) – The maximum number of record sets to return

• skip_token (str) – to be used by nextLink implementation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of DedicatedCloudService

Return type

DedicatedCloudServicePaged[DedicatedCloudService]

Raises

CSRPErrorException

list_by_subscription(filter=None, top=None, skip_token=None, custom_headers=None, raw=False, **operation_config)

Implements list of dedicatedCloudService objects within subscription method.

Returns list of dedicated cloud services within a subscription.

Parameters

• filter (str) – The filter to apply on the list operation

• top (int) – The maximum number of record sets to return

• skip_token (str) – to be used by nextLink implementation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of DedicatedCloudService

Return type

DedicatedCloudServicePaged[DedicatedCloudService]

Raises

CSRPErrorException

update(resource_group_name, dedicated_cloud_service_name, tags=None, custom_headers=None, raw=False, **operation_config)

Implements dedicatedCloudService PATCH method.

Patch dedicated cloud service’s properties.

Parameters

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

• dedicated_cloud_service_name (str) – dedicated cloud service name

• tags (dict[str, str]) – The tags key:value pairs

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DedicatedCloudService or ClientRawResponse if raw=true

Return type

DedicatedCloudService or ClientRawResponse

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.SkusAvailabilityOperations(client, config, serializer, deserializer)

Bases: object

SkusAvailabilityOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

list(region_id, sku_id=None, custom_headers=None, raw=False, **operation_config)

Implements SkuAvailability List method.

Returns list of available resources in region.

Parameters

• region_id (str) – The region Id (westus, eastus)

• sku_id (str) – sku id, if no sku is passed availability for all skus will be returned

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SkuAvailability

Return type

SkuAvailabilityPaged[SkuAvailability]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.PrivateCloudsOperations(client, config, serializer, deserializer)

Bases: object

PrivateCloudsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

get(pc_name, region_id, custom_headers=None, raw=False, **operation_config)

Implements private cloud GET method.

Returns private cloud by its name.

Parameters

• pc_name (str) – The private cloud name

• region_id (str) – The region Id (westus, eastus)

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PrivateCloud or ClientRawResponse if raw=true

Return type

PrivateCloud or ClientRawResponse

Raises

CSRPErrorException

list(region_id, custom_headers=None, raw=False, **operation_config)

Implements private cloud list GET method.

Returns list of private clouds in particular region.

Parameters

• region_id (str) – The region Id (westus, eastus)

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateCloud

Return type

PrivateCloudPaged[PrivateCloud]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.CustomizationPoliciesOperations(client, config, serializer, deserializer)

Bases: object

CustomizationPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

get(region_id, pc_name, customization_policy_name, custom_headers=None, raw=False, **operation_config)

Implements get of customization policy.

Returns customization policy by its name.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• customization_policy_name (str) – customization policy name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

CustomizationPolicy or ClientRawResponse if raw=true

Return type

CustomizationPolicy or ClientRawResponse

Raises

CSRPErrorException

list(region_id, pc_name, filter=None, custom_headers=None, raw=False, **operation_config)

Implements get of customization policies list.

Returns list of customization policies in region for private cloud.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• filter (str) – The filter to apply on the list operation. only type is allowed here as a filter e.g. $filter=type eq ‘xxxx’

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of CustomizationPolicy

Return type

CustomizationPolicyPaged[CustomizationPolicy]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.ResourcePoolsOperations(client, config, serializer, deserializer)

Bases: object

ResourcePoolsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

get(region_id, pc_name, resource_pool_name, custom_headers=None, raw=False, **operation_config)

Implements get of resource pool.

Returns resource pool templates by its name.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• resource_pool_name (str) – resource pool id (vsphereId)

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ResourcePool or ClientRawResponse if raw=true

Return type

ResourcePool or ClientRawResponse

Raises

CSRPErrorException

list(region_id, pc_name, custom_headers=None, raw=False, **operation_config)

Implements get of resource pools list.

Returns list of resource pools in region for private cloud.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourcePool

Return type

ResourcePoolPaged[ResourcePool]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.VirtualMachineTemplatesOperations(client, config, serializer, deserializer)

Bases: object

VirtualMachineTemplatesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

get(region_id, pc_name, virtual_machine_template_name, custom_headers=None, raw=False, **operation_config)

Implements virtual machine template GET method.

Returns virtual machine templates by its name.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• virtual_machine_template_name (str) – virtual machine template id (vsphereId)

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VirtualMachineTemplate or ClientRawResponse if raw=true

Return type

VirtualMachineTemplate or ClientRawResponse

Raises

CSRPErrorException

list(pc_name, region_id, resource_pool_name, custom_headers=None, raw=False, **operation_config)

Implements list of available VM templates.

Returns list of virtual machine templates in region for private cloud.

Parameters

• pc_name (str) – The private cloud name

• region_id (str) – The region Id (westus, eastus)

• resource_pool_name (str) – Resource pool used to derive vSphere cluster which contains VM templates

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualMachineTemplate

Return type

VirtualMachineTemplatePaged[VirtualMachineTemplate]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.VirtualNetworksOperations(client, config, serializer, deserializer)

Bases: object

VirtualNetworksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

get(region_id, pc_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)

Implements virtual network GET method.

Return virtual network by its name.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• virtual_network_name (str) – virtual network id (vsphereId)

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VirtualNetwork or ClientRawResponse if raw=true

Return type

VirtualNetwork or ClientRawResponse

Raises

CSRPErrorException

list(region_id, pc_name, resource_pool_name, custom_headers=None, raw=False, **operation_config)

Implements list available virtual networks within a subscription method.

Return list of virtual networks in location for private cloud.

Parameters

• region_id (str) – The region Id (westus, eastus)

• pc_name (str) – The private cloud name

• resource_pool_name (str) – Resource pool used to derive vSphere cluster which contains virtual networks

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetwork

Return type

VirtualNetworkPaged[VirtualNetwork]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.UsagesOperations(client, config, serializer, deserializer)

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

list(region_id, filter=None, custom_headers=None, raw=False, **operation_config)

Implements Usages List method.

Returns list of usage in region.

Parameters

• region_id (str) – The region Id (westus, eastus)

• filter (str) – The filter to apply on the list operation. only name.value is allowed here as a filter e.g. $filter=name.value eq ‘xxxx’

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CSRPErrorException

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

class azure.mgmt.vmwarecloudsimple.operations.VirtualMachinesOperations(client, config, serializer, deserializer)

Bases: object

VirtualMachinesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2019-04-01”.

create_or_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers=None, raw=False, polling=True, **operation_config)

Implements virtual machine PUT method.

Create Or Update Virtual Machine.

Parameters

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

• virtual_machine_name (str) – virtual machine name

• virtual_machine_request (VirtualMachine) – Create or Update Virtual Machine request

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns VirtualMachine or ClientRawResponse<VirtualMachine> if raw==True

Return type

AzureOperationPoller[VirtualMachine] or AzureOperationPoller[ClientRawResponse[VirtualMachine]]

Raises

CSRPErrorException

delete(resource_group_name, virtual_machine_name, custom_headers=None, raw=False, polling=True, **operation_config)

Implements virtual machine DELETE method.

Delete virtual machine.

Parameters

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

• virtual_machine_name (str) – virtual machine name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CSRPErrorException

get(resource_group_name, virtual_machine_name, custom_headers=None, raw=False, **operation_config)

Implements virtual machine GET method.

Get virtual machine.

Parameters

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

• virtual_machine_name (str) – virtual machine name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VirtualMachine or ClientRawResponse if raw=true

Return type

VirtualMachine or ClientRawResponse

Raises

CSRPErrorException

list_by_resource_group(resource_group_name, filter=None, top=None, skip_token=None, custom_headers=None, raw=False, **operation_config)

Implements list virtual machine within RG method.

Returns list of virtual machine within resource group.

Parameters

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

• filter (str) – The filter to apply on the list operation

• top (int) – The maximum number of record sets to return

• skip_token (str) – to be used by nextLink implementation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualMachine

Return type

VirtualMachinePaged[VirtualMachine]

Raises

CSRPErrorException

list_by_subscription(filter=None, top=None, skip_token=None, custom_headers=None, raw=False, **operation_config)

Implements list virtual machine within subscription method.

Returns list virtual machine within subscription.

Parameters

• filter (str) – The filter to apply on the list operation

• top (int) – The maximum number of record sets to return

• skip_token (str) – to be used by nextLink implementation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualMachine

Return type

VirtualMachinePaged[VirtualMachine]

Raises

CSRPErrorException

start(resource_group_name, virtual_machine_name, custom_headers=None, raw=False, polling=True, **operation_config)

Implements a start method for a virtual machine.

Power on virtual machine.

Parameters

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

• virtual_machine_name (str) – virtual machine name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CSRPErrorException

stop(resource_group_name, virtual_machine_name, mode=None, mode1=None, custom_headers=None, raw=False, polling=True, **operation_config)

Implements shutdown, poweroff, and suspend method for a virtual machine.

Power off virtual machine, options: shutdown, poweroff, and suspend.

Parameters

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

• virtual_machine_name (str) – virtual machine name

• mode (str or StopMode) – query stop mode parameter (reboot, shutdown, etc…). Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’

• mode1 (str or StopMode) – mode indicates a type of stop operation - reboot, suspend, shutdown or power-off. Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CSRPErrorException

update(resource_group_name, virtual_machine_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Implements virtual machine PATCH method.

Patch virtual machine properties.

Parameters

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

• virtual_machine_name (str) – virtual machine name

• tags (dict[str, str]) – The tags key:value pairs

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns VirtualMachine or ClientRawResponse<VirtualMachine> if raw==True

Return type

AzureOperationPoller[VirtualMachine] or AzureOperationPoller[ClientRawResponse[VirtualMachine]]

Raises

CSRPErrorException

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