Create VM Signal

The VM signal API is used for notifying Spot about the VM state so that Spot can act accordingly. Supported signals are vmReady – Whenever this signal is sent, Spot will register the instance to the relevant Load Balancer and Application Gateway. vmReadyToShutdown – When this signal is received after a vm is detached; we will immediately terminate the vm. You must define the expected signals for your Elastigroup in the group configuration.

post/azure/compute/vm/signal

Parameters

#/paths/~1azure~1costs/get/parameters/0 — unresolved $ref

Request body

vmNamestring required

The virtual machine ID the signal refers to.

signalType'vmReady' | 'vmReadyToShutdown' required

The specific signal you want to trigger.

resourceGroupNamestring required

This is the resource group of the Elastigroup or Stateful Node.

Example request

{
  "vmName": "vm-123456",
  "signalType": "vmReady",
  "resourceGroupName": "TestResourceGroup"
}

Response

Elastigroup Response

Example response

{
  "request": {
    "id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
    "timestamp": "2018-06-20T11:35:01.745Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    }
  }
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.