AzurevmClient

Classes

VirtualMachineInScaleSet dataclass

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

Response for Get virtual machine in a VM scale set

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the virtual machine.

name class-attribute instance-attribute

name: Optional[str] = None

The Name of the virtual machine.

instance_id class-attribute instance-attribute

instance_id: Optional[str] = field(default=None, 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] = None)

Response for Get virtual machine

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the virtual machine.

name class-attribute instance-attribute

name: Optional[str] = None

The Name of the virtual machine.

SubscriptionListResult dataclass

SubscriptionListResult(value: Optional[List[Subscription]] = None, next_link: Optional[str] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute

value: Optional[List[Subscription]] = None

The subscriptions.

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

ResourceGroupListResult dataclass

ResourceGroupListResult(value: Optional[List[ResourceGroup]] = None, next_link: Optional[str] = None)

Response for List resource groups

Attributes

value class-attribute instance-attribute

value: Optional[List[ResourceGroup]] = None

The list of resource groups.

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

VirtualMachineScaleSetListResult dataclass

VirtualMachineScaleSetListResult(value: Optional[List[VirtualMachineScaleSet]] = None, next_link: Optional[str] = None)

Response for List virtual machine scale sets

Attributes

value class-attribute instance-attribute

value: Optional[List[VirtualMachineScaleSet]] = None

The list of virtual machine scale sets.

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

VirtualMachineInScaleSetListResult dataclass

VirtualMachineInScaleSetListResult(value: Optional[List[VirtualMachineInScaleSet]] = 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]] = None

The list of virtual machines in a VM scale set.

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

VirtualMachineListResult dataclass

VirtualMachineListResult(value: Optional[List[VirtualMachine]] = None, next_link: Optional[str] = None)

Response for List virtual machines

Attributes

value class-attribute instance-attribute

value: Optional[List[VirtualMachine]] = None

The list of virtual machines.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, 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] = None

The fully qualified Id.

subscription_id class-attribute instance-attribute

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

The subscription Id.

tenant_id class-attribute instance-attribute

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

The tenant Id.

display_name class-attribute instance-attribute

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

The subscription display name.

state class-attribute instance-attribute

state: Optional[str] = None

The subscription state.

authorization_source class-attribute instance-attribute

authorization_source: Optional[str] = field(default=None, 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] = None

The ID of the resource group.

name class-attribute instance-attribute

name: Optional[str] = None

The Name of the resource group.

managed_by class-attribute instance-attribute

managed_by: Optional[str] = field(default=None, 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] = None)

Definition: VirtualMachineScaleSet

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the virtual machine scale set.

name class-attribute instance-attribute

name: Optional[str] = None

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] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'provisioningState'})

The state of the virtual machine.

AzurevmClient

AzurevmClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

virtual_machine_in_scale_set_get_async async

virtual_machine_in_scale_set_get_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> dict[str, Any] | None

Get virtual machine in a VM scale set

Gets a virtual machine in a VM scale set.

virtual_machine_in_scale_set_deallocate_async async

virtual_machine_in_scale_set_deallocate_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> 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.

virtual_machine_in_scale_set_power_off_async async

virtual_machine_in_scale_set_power_off_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> 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.

virtual_machine_in_scale_set_redeploy_async async

virtual_machine_in_scale_set_redeploy_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> 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.

virtual_machine_in_scale_set_reimage_async async

virtual_machine_in_scale_set_reimage_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> None

Reimage virtual machine in a VM scale set

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

virtual_machine_in_scale_set_restart_async async

virtual_machine_in_scale_set_restart_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> None

Restart virtual machine in a VM scale set

Restarts a virtual machine in a VM scale set.

virtual_machine_in_scale_set_start_async async

virtual_machine_in_scale_set_start_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str, virtual_machine_in_scale_set_instance_id: str) -> None

Start virtual machine in a VM scale set

Starts a virtual machine in a VM scale set.

virtual_machine_get_async async

virtual_machine_get_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> dict[str, Any] | None

Get virtual machine

Gets a virtual machine.

virtual_machine_start_async async

virtual_machine_start_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> None

Start virtual machine

Starts a virtual machine.

virtual_machine_deallocate_async async

virtual_machine_deallocate_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> 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.

virtual_machine_poweroff_async async

virtual_machine_poweroff_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> 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.

virtual_machine_reapply_async async

virtual_machine_reapply_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> None

Reapply virtual machine

Reapply a virtual machine's state.

virtual_machine_redeploy_async async

virtual_machine_redeploy_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> None

Redeploy virtual machine

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

virtual_machine_restart_async async

virtual_machine_restart_async(subscription_id: str, resource_group_name: str, virtual_machine_name: str) -> None

Restart virtual machine

Restarts a virtual machine.

subscriptions_list_async async

subscriptions_list_async() -> dict[str, Any] | None

List subscriptions

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

resource_groups_list_async async

resource_groups_list_async(subscription_id: str) -> dict[str, Any] | None

List resource groups

Lists all the resource groups within the subscription.

virtual_machine_scale_sets_list_async async

virtual_machine_scale_sets_list_async(subscription_id: str, resource_group_name: str) -> dict[str, Any] | None

List virtual machine scale sets

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

virtual_machines_in_scale_set_list_async async

virtual_machines_in_scale_set_list_async(subscription_id: str, resource_group_name: str, virtual_machine_scale_set_name: str) -> dict[str, Any] | None

List virtual machines in a VM scale set

Lists all the virtual machines in a VM scale set.

virtual_machines_list_async async

virtual_machines_list_async(subscription_id: str, resource_group_name: str) -> dict[str, Any] | None

List virtual machines

Lists all the virtual machines within the resource group.