Azure VM

Azure VM connector allows you to manage virtual machines.

Status: Production

Tier: Premium

Version: 2019-12-01

Actions:

Name	Summary
Subscriptions_List ([internal]string x-ms-api-version)	List subscriptions
ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId)	List resource groups
VirtualMachines_List ([internal]string x-ms-api-version, string subscriptionId, string resourceGroupName)	List virtual machines
VirtualMachines_GetOperationStatus ([internal]string api-version, string subscriptionId, [internal]string monitor, [internal]string location, [internal]string operationId)	Get virtual machine operation status
VirtualMachine_Get ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Get virtual machine
VirtualMachine_Start ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Start virtual machine
VirtualMachine_Deallocate ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Deallocate virtual machine
VirtualMachine_Poweroff ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Power off virtual machine
VirtualMachine_Reapply ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Reapply virtual machine
VirtualMachine_Redeploy ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Redeploy virtual machine
VirtualMachine_Restart ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)	Restart virtual machine

Triggers:

Name

Summary

Objects:

Name	Summary
ResourceGroup
ResourceGroupListResult
Subscription
SubscriptionListResult
VirtualMachine
VirtualMachineListResult
VirtualMachineProperties

Actions:

Subscriptions_List

Summary: List subscriptions

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

Syntax:

AzureVM.Subscriptions_List ([internal]string x-ms-api-version)

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

ARM API version

True

Returns:

Type:SubscriptionListResult

Description: Subscription list operation response.

ResourceGroups_List

Summary: List resource groups

Description: Lists all the resource groups within the subscription.

Syntax:

AzureVM.ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId)

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

ARM API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

Returns:

Type:ResourceGroupListResult

Description: List of resource groups.

VirtualMachines_List

Summary: List virtual machines

Description: Lists all the virtual machines within the resource group.

Syntax:

AzureVM.VirtualMachines_List ([internal]string x-ms-api-version, string subscriptionId, string resourceGroupName)

Parameters:

Name	Type	Summary	Required	Related Action
x-ms-api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List

Returns:

Type:VirtualMachineListResult

Description: List of virtual machines.

VirtualMachines_GetOperationStatus

Summary: Get virtual machine operation status

Description: Get status of an operation on a virtual machine.

Syntax:

AzureVM.VirtualMachines_GetOperationStatus ([internal]string api-version, string subscriptionId, [internal]string monitor, [internal]string location, [internal]string operationId)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
monitor	string (Monitor the operation)		True
location	string (Location of the virtual machine)		True
operationId	string (Id of the operation to track)		True

Returns:

VirtualMachine_Get

Summary: Get virtual machine

Description: Gets a virtual machine.

Syntax:

AzureVM.VirtualMachine_Get ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

Type:VirtualMachine

Description: Virtual Machine information.

VirtualMachine_Start

Summary: Start virtual machine

Description: Starts a virtual machine.

Syntax:

AzureVM.VirtualMachine_Start ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

VirtualMachine_Deallocate

Summary: Deallocate virtual machine

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

Syntax:

AzureVM.VirtualMachine_Deallocate ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

VirtualMachine_Poweroff

Summary: Power off virtual machine

Description: 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.

Syntax:

AzureVM.VirtualMachine_Poweroff ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

VirtualMachine_Reapply

Summary: Reapply virtual machine

Description: Reapply a virtual machine's state.

Syntax:

AzureVM.VirtualMachine_Reapply ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

VirtualMachine_Redeploy

Summary: Redeploy virtual machine

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

Syntax:

AzureVM.VirtualMachine_Redeploy ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

VirtualMachine_Restart

Summary: Restart virtual machine

Description: Restarts a virtual machine.

Syntax:

AzureVM.VirtualMachine_Restart ([internal]string api-version, string subscriptionId, string resourceGroupName, string virtualMachineName)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	Compute API version	True
subscriptionId	string (Subscription Id)	Microsoft Azure subscription.	True	Subscriptions_List
resourceGroupName	string (Resource Group)	The name of the resource group.	True	ResourceGroups_List
virtualMachineName	string (Virtual Machine)	The name of the virtual machine.	True	VirtualMachines_List

Returns:

ResourceGroup

Summary:

Description: Resource group information.

Properties:

Name	Type	Summary
id	string Id	The ID of the resource group.
name	string Name	The Name of the resource group.
managedBy	string Managed By	Id of the resource that manages this resource group.

ResourceGroupListResult

Summary:

Description: List of resource groups.

Properties:

Name

Type

Summary

value

array of (ResourceGroup)

The list of resource groups.

nextLink

string

Next Link

The URL to get the next set of results.

Subscription

Summary:

Description: Subscription information.

Properties:

Name	Type	Summary
id	string Id	The fully qualified Id.
subscriptionId	string Subscription Id	The subscription Id.
tenantId	string Tenant Id	The tenant Id.
displayName	string Display Name	The subscription display name.
state	string State	The subscription state. Values: [Enabled, Warned, PastDue, Disabled, Deleted]
authorizationSource	string Authorization Source	The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

SubscriptionListResult

Summary:

Description: Subscription list operation response.

Properties:

Name

Type

Summary

value

array of (Subscription)

The subscriptions.

nextLink

string

Next Link

The URL to get the next set of results.

VirtualMachine

Summary:

Description: Virtual Machine information.

Properties:

Name	Type	Summary
id	string Id	The ID of the virtual machine.
name	string Name	The Name of the virtual machine.
properties	VirtualMachineProperties	Virtual Machine properties.

VirtualMachineListResult

Summary:

Description: List of virtual machines.

Properties:

Name

Type

Summary

value

array of (VirtualMachine)

The list of virtual machines.

nextLink

string

Next Link

The URL to get the next set of results.

VirtualMachineProperties

Summary:

Description: Virtual Machine properties.

Properties:

Name

Type

Summary

provisioningState

string

ProvisioningState

The state of the virtual machine.