UiPath Activities

The UiPath Activities Guide

Create VM

UiPath.Azure.Activities.CreateVM

Creates a new virtual machine from a disk or image.

Properties

Administrator Credentials

  • AdminPassword - Specifies the password for the provided username. This field supports only SecureString variables.
  • AdminUsername - Specifies the administrator's username for the virtual machine. This field supports only strings and String variables.
  • SSHPublicKey - Specifies the SSH public key. This field supports only SecureString variables.

Note:

Make sure to input a value for one of the following parameters: Password or SSHPublicKey. If both parameters are set, then only SSHPublicKey is taken into consideration.

Common

  • DisplayName - The display name of the activity. This field supports only strings and String variables.

Configuration

  • ComputerName - Specifies the name of the computer. This field supports only strings and String variables.
  • Disk - Specifies the disk of the virtual machine.
  • DNSName - Specifies the name label of the DNS. This field supports only strings and String variables.
  • Image - Specifies the virtual machine image.

Note:

Make sure to input a value for one of the following parameters: Disk or Image. If both parameters are set, then only Disk is taken into consideration.

  • ImageLicensed - Specifies the use of an Azure or on-premise license. The possible values are AzureLicensed, WindowsClient, and WindowsServer. The default value is AzureLicensed.
  • OSDiskType - Specifies the OS disk type. This value is ignored if the virtual machine is created from disk. The possible values are StandardLRS, PremiumLRS, StandardSSDLRS, and UltraSSDLRS. The default value is StandardLRS.
  • Size - Specifies the size of the virtual machine. This field supports only strings and String variables. The possible values are listed in the below drop-down list.

Add one of the possible values below, as a string, in the Size field.

  • Basic_A0
  • Basic_A1
  • Basic_A2
  • Basic_A3
  • Basic_A4
  • Standard_A0
  • Standard_A1
  • Standard_A2
  • Standard_A3
  • Standard_A4
  • Standard_A5
  • Standard_A6
  • Standard_A7
  • Standard_A8
  • Standard_A9
  • Standard_A10
  • Standard_A11
  • Standard_A1_v2
  • Standard_A2_v2
  • Standard_A4_v2
  • Standard_A8_v2
  • Standard_A2m_v2
  • Standard_A4m_v2
  • Standard_A8m_v2
  • Standard_B1s
  • Standard_B1ms
  • Standard_B2s
  • Standard_B2ms
  • Standard_B4ms
  • Standard_B8ms
  • Standard_D1
  • Standard_D2
  • Standard_D3
  • Standard_D4
  • Standard_D11
  • Standard_D12
  • Standard_D13
  • Standard_D14
  • Standard_D1_v2
  • Standard_D2_v2
  • Standard_D3_v2
  • Standard_D4_v2
  • Standard_D5_v2
  • Standard_D2_v3
  • Standard_D4_v3
  • Standard_D8_v3
  • Standard_D16_v3
  • Standard_D32_v3
  • Standard_D64_v3
  • Standard_D2s_v3
  • Standard_D4s_v3
  • Standard_D8s_v3
  • Standard_D16s_v3
  • Standard_D32s_v3
  • Standard_D64s_v3
  • Standard_D11_v2
  • Standard_D12_v2
  • Standard_D13_v2
  • Standard_D14_v2
  • Standard_D15_v2
  • Standard_DS1
  • Standard_DS2
  • Standard_DS3
  • Standard_DS4
  • Standard_DS11
  • Standard_DS12
  • Standard_DS13
  • Standard_DS14
  • Standard_DS1_v2
  • Standard_DS2_v2
  • Standard_DS3_v2
  • Standard_DS4_v2
  • Standard_DS5_v2
  • Standard_DS11_v2
  • Standard_DS12_v2
  • Standard_DS13_v2
  • Standard_DS14_v2
  • Standard_DS15_v2
  • Standard_DS13-4_v2
  • Standard_DS13-2_v2
  • Standard_DS14-8_v2
  • Standard_DS14-4_v2
  • Standard_E2_v3
  • Standard_E4_v3
  • Standard_E8_v3
  • Standard_E16_v3
  • Standard_E32_v3
  • Standard_E64_v3
  • Standard_E2s_v3
  • Standard_E4s_v3
  • Standard_E8s_v3
  • Standard_E16s_v3
  • Standard_E32s_v3
  • Standard_E64s_v3
  • Standard_E32-16_v3
  • Standard_E32-8s_v3
  • Standard_E64-32s_v3
  • Standard_E64-16s_v3
  • Standard_F1
  • Standard_F2
  • Standard_F4
  • Standard_F8
  • Standard_F16
  • Standard_F1s
  • Standard_F2s
  • Standard_F4s
  • Standard_F8s
  • Standard_F16s
  • Standard_F2s_v2
  • Standard_F4s_v2
  • Standard_F8s_v2
  • Standard_F16s_v2
  • Standard_F32s_v2
  • Standard_F64s_v2
  • Standard_F72s_v2
  • Standard_G1
  • Standard_G2
  • Standard_G3
  • Standard_G4
  • Standard_G5
  • Standard_GS1
  • Standard_GS2
  • Standard_GS3
  • Standard_GS4
  • Standard_GS5
  • Standard_GS4-8
  • Standard_GS4-4
  • Standard_GS5-16
  • Standard_GS5-8
  • Standard_H8
  • Standard_H16
  • Standard_H8m
  • Standard_H16m
  • Standard_H16r
  • Standard_H16mr
  • Standard_L4s
  • Standard_L8s
  • Standard_L16s
  • Standard_L32s
  • Standard_M64s
  • Standard_M64ms
  • Standard_M128s
  • Standard_M128ms
  • Standard_M64-32ms
  • Standard_M64-16ms
  • Standard_M128-64ms
  • Standard_M128-32ms,
  • Standard_NC6,
  • Standard_NC12,
  • Standard_NC24
  • Standard_NC24r
  • Standard_NC6s_v2
  • Standard_NC12s_v2
  • Standard_NC24s_v2
  • Standard_NC24rs_v2
  • Standard_NC6s_v3
  • Standard_NC12s_v3
  • Standard_NC24s_v3
  • Standard_NC24rs_v3
  • Standard_ND6s
  • Standard_ND12s
  • Standard_ND24s
  • Standard_ND24rs
  • Standard_NV6
  • Standard_NV12
  • Standard_NV24

Note:

More information about the Size parameter's possible values can be found here.

Input

  • Name - Specifies the name of the new virtual machine. This field supports only strings and String variables.
  • Region - Establishes the Azure region (which is an area within a geographical place, containing one or more datacenters) of the virtual machine. If not specified, the region from the resource group is used. If a custom image is provided, then it uses the region specified for the image. This field supports only strings and String variables. The possible values are listed in the below drop-down list.

Add one of the possible values below, as a string, in the Region field.

  • westus
  • westus2
  • centralus
  • eastus
  • eastus2
  • northcentralus
  • southcentralus
  • westcentralus
  • canadacentral
  • canadaeast
  • brazilsouth
  • northeurope
  • westeurope
  • uksouth
  • ukwest
  • eastasia
  • southeastasia
  • japaneast
  • japanwest
  • australiaeast
  • australiasoutheast
  • australiacentral
  • australiacentral2
  • centralindia
  • southindia
  • westindia
  • koreasouth
  • koreacentral
  • chinanorth
  • chinaeast
  • germanycentral
  • germanynortheast
  • usgovvirginia
  • usgoviowa
  • usgovarizona
  • usgovtexas
  • usdodeast
  • usdodcentral

Note:

More information about the Region parameter's possible values can be found here.

  • ResourceGroupName - Specifies the name of the resource group. This field supports only strings and String variables.
  • Tags - Specifies the resource tags. It should have two columns, name and value.
  • Timeout - Specifies how long to wait (in seconds) for the activity to run before an error is thrown. If not set, the activity runs until completion.
  • WaitForCompletion - When selected, waits for the activity to be completed before moving to the next activity. When the option is not selected, the activity ends immediately after the API call is made. The default value is True.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Networking

  • HasPublicIPAddress - Specifies if the virtual machine has a public IP address or not. The default value is False.
  • NetworkSecurityGroupName - Specifies the name of the network security group. This parameter is taken into consideration only when the NICNetworkSecurityGroup parameter has the value Advanced. This field supports only strings and String variables.
  • NICNetworkSecurityGroup - Specifies the type of NIC network security group. The possible values are None, Basic, Advanced. The default value is None.
  • PublicInboundPorts - Specifies the list of public inbound ports. If a value is not set, all internet traffic is blocked. This parameter is used only when the NICNetworkSecurityGroup parameter has the value Basic.
  • PublicIPAddressName - Specifies the name of a public IP address. If the HasPublicIPAddress parameter has the value True but this parameter is not set, then it autogenerates a public IP address name. This field supports only strings and String variables.
  • SubnetName - Specifies the name of the subnet. If no value is added, then the default subnet name is used. This field supports only strings and String variables.
  • VirtualNetworkName - Specifies the name of the virtual network that needs to be joined by the newly created machine. If no value is added, then a new virtual network is created. This field supports only strings and String variables.

Output

  • VirtualMachine - Provides details about the newly created virtual machine.

Updated 8 months ago


Create VM


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.