Sign in
latestOpenAPI 3.0.02026-08-2045003.8 MB

72813baf8d47

Elastigroup Azure Spot VMs

Detach VMs

Scale down specific virtual machines in Elastigroup cluster.

put/azure/compute/group/{groupId}/detachVms

Parameters

#/paths/~1azure~1costs/get/parameters/0 — unresolved $ref
#/paths/~1aws~1ec2~1group~1%7BgroupId%7D/put/parameters/0 — unresolved $ref

Request body

vmsToDetachstring[] required

Array of virtual machine names to detach.

shouldTerminateVmsboolean required

Whether to terminate the VMs or not.

shouldDecrementTargetCapacityboolean required

Prevent Elastigroup from scaling back to target capacity when virtual machines are detached.

shouldDeregisterVmFromLbboolean

Indicates whether to deregister the stateful node's VM from any type of load balancer. Will only be applied if the shouldTerminateVms is 'false'

drainingTimeoutstring

The time in seconds to allow the virtual machine be be drained from incoming TCP connections and detached from MLB before terminating it.

Example request

{
  "vmsToDetach": [
    "vm-0fbd69f960db"
  ],
  "shouldTerminateVms": true,
  "shouldDecrementTargetCapacity": true,
  "shouldDeregisterVmFromLb": true
}