Upgrades the operating system of the specified pool.

v1.0.0

During an upgrade, the Batch service upgrades each compute node in the pool. When a compute node is chosen for upgrade, any tasks running on that node are removed from the node and returned to the queue to be rerun later (or on a different compute node). The node will be unavailable until the upgrade is complete. This operation results in temporarily reduced pool capacity as nodes are taken out of service to be upgraded. Although the Batch service tries to avoid upgrading all compute nodes at the same time, it does not guarantee to do this (particularly on small pools); therefore, the pool may be temporarily unavailable to run tasks. When this operation runs, the pool state changes to upgrading. When all compute nodes have finished upgrading, the pool state returns to active. While the upgrade is in progress, the pool's currentOSVersion reflects the OS version that nodes are upgrading from, and targetOSVersion reflects the OS version that nodes are upgrading to. Once the upgrade is complete, currentOSVersion is updated to reflect the OS version now running on all nodes. This operation can only be invoked on pools created with the cloudServiceConfiguration property.

Input

{
  "type": "object",
  "properties": {
    "If-Match": {
      "type": "string"
    },
    "If-Modified-Since": {
      "type": "string"
    },
    "If-None-Match": {
      "type": "string"
    },
    "If-Unmodified-Since": {
      "type": "string"
    },
    "api-version": {
      "type": "string"
    },
    "client-request-id": {
      "type": "string"
    },
    "ocp-date": {
      "type": "string"
    },
    "poolId": {
      "type": "string"
    },
    "return-client-request-id": {
      "type": "string"
    },
    "timeout": {
      "type": "string"
    }
  },
  "required": [
    "api-version",
    "poolId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}