AzurevmClient

Classes

VirtualMachineInScaleSet dataclass

VirtualMachineInScaleSet(*, id: Optional[str] = None, name: Optional[str] = None, instance_id: Optional[str] = None, properties: Optional[VirtualMachineInScaleSetProperties | Mapping[str, Any]] = None)

Response for Get virtual machine in a VM scale set

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the virtual machine.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the virtual machine.

instance_id class-attribute instance-attribute

instance_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'instanceId'})

The instance Id of the virtual machine.

VirtualMachine dataclass

VirtualMachine(*, id: Optional[str] = None, name: Optional[str] = None, properties: Optional[VirtualMachineProperties | Mapping[str, Any]] = None)

Response for Get virtual machine

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the virtual machine.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the virtual machine.

SubscriptionListResult dataclass

SubscriptionListResult(*, value: Optional[List[Subscription | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute

value: Optional[List[Subscription | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The subscriptions.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ResourceGroupListResult dataclass

ResourceGroupListResult(*, value: Optional[List[ResourceGroup | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List resource groups

Attributes

value class-attribute instance-attribute

value: Optional[List[ResourceGroup | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resource groups.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

VirtualMachineScaleSetListResult dataclass

VirtualMachineScaleSetListResult(*, value: Optional[List[VirtualMachineScaleSet | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List virtual machine scale sets

Attributes

value class-attribute instance-attribute

value: Optional[List[VirtualMachineScaleSet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of virtual machine scale sets.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

VirtualMachineInScaleSetListResult dataclass

VirtualMachineInScaleSetListResult(*, value: Optional[List[VirtualMachineInScaleSet | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List virtual machines in a VM scale set

Attributes

value class-attribute instance-attribute

value: Optional[List[VirtualMachineInScaleSet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of virtual machines in a VM scale set.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

VirtualMachineListResult dataclass

VirtualMachineListResult(*, value: Optional[List[VirtualMachine | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List virtual machines

Attributes

value class-attribute instance-attribute

value: Optional[List[VirtualMachine | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of virtual machines.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

Subscription dataclass

Subscription(*, id: Optional[str] = None, subscription_id: Optional[str] = None, tenant_id: Optional[str] = None, display_name: Optional[str] = None, state: Optional[str] = None, authorization_source: Optional[str] = None)

Definition: Subscription

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The fully qualified Id.

subscription_id class-attribute instance-attribute

subscription_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

The tenant Id.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The subscription display name.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

The subscription state.

authorization_source class-attribute instance-attribute

authorization_source: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'authorizationSource'})

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

ResourceGroup dataclass

ResourceGroup(*, id: Optional[str] = None, name: Optional[str] = None, managed_by: Optional[str] = None)

Definition: ResourceGroup

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the resource group.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the resource group.

managed_by class-attribute instance-attribute

managed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managedBy'})

Id of the resource that manages this resource group.

VirtualMachineScaleSet dataclass

VirtualMachineScaleSet(*, id: Optional[str] = None, name: Optional[str] = None, properties: Optional[VirtualMachineScaleSetProperties | Mapping[str, Any]] = None)

Definition: VirtualMachineScaleSet

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the virtual machine scale set.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the virtual machine scale set.

VirtualMachineScaleSetProperties dataclass

VirtualMachineScaleSetProperties(*, provisioning_state: Optional[str] = None)

Definition: VirtualMachineScaleSetProperties

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisioningState'})

The state of the virtual machine scale set.

VirtualMachineInScaleSetProperties dataclass

VirtualMachineInScaleSetProperties(*, provisioning_state: Optional[str] = None)

Definition: VirtualMachineInScaleSetProperties

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisioningState'})

The state of the virtual machine.

VirtualMachineProperties dataclass

VirtualMachineProperties(*, provisioning_state: Optional[str] = None)

Definition: VirtualMachineProperties

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisioningState'})

The state of the virtual machine.

AzurevmClient

AzurevmClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for azurevm connector.

Initialize a AzurevmClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

virtual_machine_in_scale_set_get async

virtual_machine_in_scale_set_get(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get virtual machine in a VM scale set

Gets a virtual machine in a VM scale set.

Swagger operation ID: VirtualMachineInScaleSet_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_in_scale_set_deallocate async

virtual_machine_in_scale_set_deallocate(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Deallocate virtual machine in a VM scale set

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.

Swagger operation ID: VirtualMachineInScaleSet_Deallocate.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_in_scale_set_power_off async

virtual_machine_in_scale_set_power_off(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Power off virtual machine in a VM scale set

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.

Swagger operation ID: VirtualMachineInScaleSet_PowerOff.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_in_scale_set_redeploy async

virtual_machine_in_scale_set_redeploy(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Redeploy virtual machine in a VM scale set

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

Swagger operation ID: VirtualMachineInScaleSet_Redeploy.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_in_scale_set_reimage async

virtual_machine_in_scale_set_reimage(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Reimage virtual machine in a VM scale set

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

Swagger operation ID: VirtualMachineInScaleSet_Reimage.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_in_scale_set_restart async

virtual_machine_in_scale_set_restart(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Restart virtual machine in a VM scale set

Restarts a virtual machine in a VM scale set.

Swagger operation ID: VirtualMachineInScaleSet_Restart.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_in_scale_set_start async

virtual_machine_in_scale_set_start(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Start virtual machine in a VM scale set

Starts a virtual machine in a VM scale set.

Swagger operation ID: VirtualMachineInScaleSet_Start.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
virtual_machine_in_scale_set_instance_id	str	The name of the virtual machine in a VM scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_get async

virtual_machine_get(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get virtual machine

Gets a virtual machine.

Swagger operation ID: VirtualMachine_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_start async

virtual_machine_start(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Start virtual machine

Starts a virtual machine.

Swagger operation ID: VirtualMachine_Start.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_deallocate async

virtual_machine_deallocate(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Deallocate virtual machine

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

Swagger operation ID: VirtualMachine_Deallocate.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_poweroff async

virtual_machine_poweroff(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Power off virtual machine

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.

Swagger operation ID: VirtualMachine_Poweroff.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_reapply async

virtual_machine_reapply(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Reapply virtual machine

Reapply a virtual machine's state.

Swagger operation ID: VirtualMachine_Reapply.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_redeploy async

virtual_machine_redeploy(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Redeploy virtual machine

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

Swagger operation ID: VirtualMachine_Redeploy.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

virtual_machine_restart async

virtual_machine_restart(subscription_id: str, resource_group_name: str, virtual_machine_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Restart virtual machine

Restarts a virtual machine.

Swagger operation ID: VirtualMachine_Restart.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_name	str	The name of the virtual machine.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_subscriptions

list_subscriptions(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List subscriptions

Gets a list of all the subscriptions to which the principal has access.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Subscriptions_List.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_resource_groups

list_resource_groups(subscription_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List resource groups

Lists all the resource groups within the subscription.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ResourceGroups_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_virtual_machine_scale_sets

list_virtual_machine_scale_sets(subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List virtual machine scale sets

Lists all the virtual machine scale sets within the resource group.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: VirtualMachineScaleSets_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_virtual_machines_in_scale_set

list_virtual_machines_in_scale_set(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List virtual machines in a VM scale set

Lists all the virtual machines in a VM scale set.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: VirtualMachinesInScaleSet_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
virtual_machine_scale_set_name	str	The name of the virtual machine scale set.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_virtual_machines

list_virtual_machines(subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List virtual machines

Lists all the virtual machines within the resource group.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: VirtualMachines_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	Microsoft Azure subscription.	required
resource_group_name	str	The name of the resource group.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.