Stop

The Stop VM operation is used to stop an existing virtual machine (VM) in the Azure environment. This operation can be useful for conserving resources or performing maintenance.

Properties

INPUT

ReservePublicIPAddress: Indicates whether to retain the public IP address associated with the virtual machine when stopping it. When checked (true), the public IP address will be reserved and associated with the VM when it is restarted. If unchecked (false), the public IP address may be released, and a new IP address might be assigned when the VM is started again.

WaitForCompletion: When the value is True, it waits for the activity to be completed before moving to the next activity. When the value is False, the activity ends immediately after the API call is made. The default value is True.

VirtualMachine*: Specifies the name of the virtual machine you want to stop. This field supports only strings.

WaitIntervalSeconds:  Specifies the interval (in seconds) between checks for completion if WaitForCompletion is enabled. This field allows the system to poll for the stop status at regular intervals until the operation is complete.

MISC

DisplayName: Displays the name of the activity. The activity name can be customized which will help in troubleshooting.

SkipOnError: Specify the “Boolean” value as “True” or “False.”

True: Continue executing the workflow regardless of any errors thrown.
False: Halt the workflow if it encounters any errors.
None: If the option is left blank, the activity will, by default, behave as if “False” were chosen.

Version: Indicates the version of the activity.

OUTPUT

Result: Provides the success status of the operation. This field indicates whether the VM was successfully stopped or if there were any issues during the operation. It provides the ability to view the execution status of the activity. It returns values in “Boolean.”
True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

* Represents mandatory fields to execute the workflow

Notes 

1. When ReservePublicIPAddress is checked (true), the public IP address will be retained for the VM, ensuring that the same IP address is assigned when the VM is restarted. This is important for scenarios where a static IP address is needed.
2. The WaitForCompletion property controls whether the system waits for the VM to stop fully before completing the operation. If enabled, the system will check for completion at intervals specified by WaitIntervalSeconds.
3. Stopping a VM will deallocate it, releasing its compute resources but not necessarily its associated public IP address unless ReservePublicIPAddress is set to false.