Azure Compute

Latest Dynatrace
Reference
20-min read

Disks: Create or update

Creates or updates a disk.

For more information, see the official documentation for Disks: Create or update.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
diskName	string	The name of the managed disk that is being created.	Required
disk	Disk	See disk fields.	Required

disk (Disk)

Field	Type	Description	Required
location	string	The geo-location where the resource lives.	Required
diskSizeGB	number	If creationData.createOption is Empty, this field is mandatory, and it indicates the size of the disk to create.	Optional
tags	Record<string, string>	Resource tags.	Optional
creationData	CreationData	See creationData fields.	Optional

disk.creationData (CreationData)

Field	Type	Description	Required
createOption	string	This enumerates the possible sources of a disk's creation.	Required
elasticSanResourceId	string	Required if createOption is CopyFromSanSnapshot.	Optional
imageReference	ImageDiskReference	Disk source information for PIR or user images.	Optional
securityDataUri	string	If createOption is ImportSecure, this is the URI of a blob to be imported into the VM guest state.	Optional
sourceResourceId	string	If createOption is Copy, this is the ARM id of the source snapshot or disk.	Optional
sourceUri	string	If createOption is Import, this is the URI of a blob to be imported into a managed disk.	Optional
storageAccountId	string	Required if createOption is Import.	Optional

Outputs

The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in Disk.

Snapshots: Create or update

Creates or updates a snapshot.

For more information, see the official documentation for Snapshots: Create or update.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
snapshotName	string	The name of the snapshot that is being created.	Required
snapshot	Snapshot	See snapshot fields.	Required

snapshot (Snapshot)

Field	Type	Description	Required
location	string	The geo-location where the resource lives.	Required
tags	Record<string, string>	Resource tags.	Optional
creationData	CreationData	See creationData fields.	Optional

snapshot.creationData (CreationData)

Field	Type	Description	Required
createOption	string	This enumerates the possible sources of a disk's creation.	Required
sourceResourceId	string	If createOption is Copy, this is the ARM id of the source snapshot or disk.	Optional
storageAccountId	string	Required if createOption is Import.	Optional
sourceUri	string	If createOption is Import, this is the URI of a blob to be imported into a managed disk.	Optional

Outputs

The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in Snapshot.

Virtual Machine Scale Set VMs: List

Gets a list of all virtual machines in a VM scale set.

For more information, see the official documentation for Virtual Machine Scale Set VMs: List.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
virtualMachineScaleSetName	string	The name of the VirtualMachineScaleSet.	Required

Outputs

Returns an array of VirtualMachineScaleSetVM objects.

Virtual Machine Scale Sets: Create or update

Create or update a VM scale set.

For more information, see the official documentation for Virtual Machine Scale Sets: Create or update.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmScaleSetName	string	The name of the VM scale set.	Required
parameters	VirtualMachineScaleSet	The scale set object.	Required

Outputs

The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in VirtualMachineScaleSet.

Virtual Machine Scale Sets: Deallocate

Deallocates specific virtual machines in a VM scale set.

For more information, see the official documentation for Virtual Machine Scale Sets: Deallocate.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmScaleSetName	string	The name of the VM scale set.	Required

Outputs

The action does not have an output.

Virtual Machine Scale Sets: Restart

Restarts one or more virtual machines in a VM scale set.

For more information, see the official documentation for Virtual Machine Scale Sets: Restart.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmScaleSetName	string	The name of the VM scale set.	Required

Outputs

The action does not have an output.

Virtual Machine Scale Sets: Get

Display information about a virtual machine scale set.

For more information, see the official documentation for Virtual Machine Scale Sets: Get.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmScaleSetName	string	The name of the VM scale set.	Required

Outputs

Returns fields as described in VirtualMachineScaleSet.

Virtual Machine Scale Sets: List skus

Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

For more information, see the official documentation for Virtual Machine Scale Sets: List skus.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmScaleSetName	string	The name of the VM scale set.	Required

Outputs

Returns an array of VirtualMachineScaleSetSku objects.

Virtual Machine Scale Sets: List

Gets a list of all VM scale sets under a resource group.

For more information, see the official documentation for Virtual Machine Scale Sets: List.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required

Outputs

Returns an array of VirtualMachineScaleSet objects.

Virtual Machines: Create or update

The operation to create or update a virtual machine.

For more information, see the official documentation for Virtual Machines: Create or update.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required
parameters	VirtualMachine	See parameters fields.	Required

parameters (VirtualMachine)

Field	Type	Description	Required
location	string	The geo-location where the resource lives.	Required
identity	VirtualMachineIdentity	The identity of the virtual machine, if configured.	Optional
hardwareProfile	HardwareProfile	See hardwareProfile fields.	Optional
storageProfile	StorageProfile	See storageProfile fields.	Optional
osProfile	OSProfile	See osProfile fields.	Optional
networkProfile	NetworkProfile	See networkProfile fields.	Optional

parameters.hardwareProfile (HardwareProfile)

Field	Type	Description	Required
vmSize	string	Specifies the size of the virtual machine.	Optional

parameters.storageProfile (StorageProfile)

Field	Type	Description	Required
imageReference	ImageReference	Specifies information about the image to use.	Optional
osDisk	OSDisk	Specifies information about the operating system disk used by the virtual machine.	Optional
dataDisks	DataDisk[]	Specifies the parameters that are used to add a data disk to a virtual machine.	Optional

parameters.osProfile (OSProfile)

Field	Type	Description	Required
computerName	string	Specifies the host OS name of the virtual machine.	Optional
adminUsername	string	Specifies the name of the administrator account.	Optional
adminPassword	string	Specifies the password of the administrator account.	Optional
linuxConfiguration	LinuxConfiguration	Specifies the Linux operating system settings on the virtual machine.	Optional

parameters.networkProfile (NetworkProfile)

Field	Type	Description	Required
networkInterfaces	NetworkInterfaceReference[]	Specifies the list of resource IDs for the network interfaces associated with the virtual machine.	Optional

For the adminPassword field, select a credential from the credential vault dropdown to provide the administrator password securely.

Only token or user-password credentials with credential scopes can be used as input. For more information, see Credential scopes.

Outputs

The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in VirtualMachine.

Virtual Machines: Deallocate

Shuts down the virtual machine and releases the compute resources.

For more information, see the official documentation for Virtual Machines: Deallocate.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Delete

The operation to delete a virtual machine.

For more information, see the official documentation for Virtual Machines: Delete.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Install patches

Installs patches on the VM.

For more information, see the official documentation for Virtual Machines: Install patches.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required
installPatchesInput	VirtualMachineInstallPatchesParameters	Input for InstallPatches as directly received by the API.	Required

Outputs

The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in VirtualMachineInstallPatchesResult.

Virtual Machines: Perform maintenance

The operation to perform maintenance on a virtual machine.

For more information, see the official documentation for Virtual Machines: Perform maintenance.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Power off

The operation to power off (stop) a virtual machine.

For more information, see the official documentation for Virtual Machines: Power off.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Redeploy

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

For more information, see the official documentation for Virtual Machines: Redeploy.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Restart

The operation to restart a virtual machine.

For more information, see the official documentation for Virtual Machines: Restart.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Run command

Run command on the VM.

For more information, see the official documentation for Virtual Machines: Run command.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required
parameters	RunCommandInput	See parameters fields.	Required

parameters (RunCommandInput)

Field	Type	Description	Required
commandId	string	Specifies a commandId of a predefined built-in script.	Required
parameters	RunCommandInputParameter[]	The run command parameters.	Optional
script	string[]	The script to be executed.	Optional

Outputs

The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in RunCommandResult.

Virtual Machines: Start

The operation to start a virtual machine.

For more information, see the official documentation for Virtual Machines: Start.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Generalize

Sets the OS state of the virtual machine to generalized.

For more information, see the official documentation for Virtual Machines: Generalize.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

The action does not have an output.

Virtual Machines: Get

Retrieves information about the model view or the instance view of a virtual machine.

For more information, see the official documentation for Virtual Machines: Get.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

Returns fields as described in VirtualMachine.

Virtual Machines: Instance view

Retrieves information about the run-time state of a virtual machine.

For more information, see the official documentation for Virtual Machines: Instance view.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
vmName	string	The name of the virtual machine.	Required

Outputs

Returns fields as described in VirtualMachineInstanceView.

Virtual Machines: List all

Lists all of the virtual machines in the specified subscription.

For more information, see the official documentation for Virtual Machines: List all.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
options	VirtualMachinesListAllOptionalParams	See options fields.	Optional

options (VirtualMachinesListAllOptionalParams)

Field	Type	Description	Required
filter	string	The system query option to filter VMs returned in the response.	Optional

Outputs

Returns an array of VirtualMachine objects.

Virtual Machines: List

Lists all of the virtual machines in the specified resource group.

For more information, see the official documentation for Virtual Machines: List.

Inputs

Field	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Required
resourceGroupName	string	The name of the resource group.	Required
options	VirtualMachinesListOptionalParams	See options fields.	Optional

options (VirtualMachinesListOptionalParams)

Field	Type	Description	Required
filter	string	The system query option to filter VMs returned in the response.	Optional

Outputs

Returns an array of VirtualMachine objects.