POSThttps://api.spotinst.io/azure/compute/group/{GROUP_ID}/deployment?accountId={ACCOUNT_ID}

               Deploy the Elastigroup. This triggers a Blue/Green deployment that replaces the existing VMs in the Elastigroup.

URL Parameters

Parameter Type Description
GROUP_ID * String

The Elastigroup ID you want to roll.

Example: sig-12345
ACCOUNT_ID String

Your Spot accountId associated with your token.

Example: act-123abc
Request - Update group

Headers
Copied!
Downloaded!
{  
   "Content-Type": "application/json",
   "Authorization": "Bearer ${token}" 
}
Body
Copied!
Downloaded!
{
    "deployment": {
       "batchSizePercentage": 50,
       "gracePeriod": 2,
       "batchMinHealthyPercentage": 100,
       "drainingTimeout": 0,
       "healthCheckTypes": ["vmState"]
    }
}

Body Attributes:


Attribute Type Description
deployment.batchSizePercentage * Integer

Indicates (in percentage) the batch size of the deployment (meaning, how many nodes to replace in each batch). Valid values: 1-100. Cannot be null.

Example: 50
Default: 25
deployment.gracePeriod Integer

Indicates (in seconds) the timeout to wait until the node becomes healthy. Must be at least 300.

Example: 300
Default: 600
deployment.batchMinHealthyPercentage Integer

Indicates the threshold of minimum healthy virtual machines in a single batch. If the amount of healthy virtual machines in a single batch is under the threshold, the deployment will fail. If exists, the parameter value will be in the range of 1-100. In case of null as value, the default value in the backend will be 50%. The value of the parameter should represent the number in percentage (%) of the batch.

Example: 100
Default: 50
deployment.drainingTimeout Integer

Indicates (in seconds) the timeout to drain the instances. Minimum 0. Can be null.

Example: 120
Default: The Elastigroups draining time out or 120.
deployment.healthCheckTypes String

Define a health check type. Valid values: "vmState", "applicationGateway". Can be null. If no value is set, the deployment will use the group’s auto-healing health check.

Response - 200

Headers
Copied!
Downloaded!
{
  Content-Type: application/json
}
Body
Copied!
Downloaded!
{
    "request": {
        "id": "2643aa37-1cd5-48ed-8191-5a6ade361a2d",
        "url": "/azure/compute/group/sig-a7aa60cd/deployment?accountId=act-49372faf",
        "method": "POST",
        "timestamp": "2020-06-22T11:16:12.786Z"
    },
    "response": {
        "status": {
            "code": 200,
            "message": "OK"
        },
        "kind": "spotinst:azure:compute:deployment",
        "items": [
            {
                "id": "sbgd-f331fb8e",
                "groupId": "sig-a7aa60cd",
                "status": "deploymentStart",
                "currentBatch": 1,
                "numOfBatches": 1,
                "progress": {
                    "unit": "percentage",
                    "value": 0.0
                },
                "updatedAt": "2020-06-22T11:15:06.614Z",
                "createdAt": "2020-06-22T11:15:06.614Z"
            }
        ],
        "count": 1
    }
}