POST /api/tenants/{id}/stop

Stops an tenant in Azure.

Remarks

The method returns HTTP 202 and a reference to the job in the LOCATION header.

Request

Parameter Description Additional information
id The id of the tenant to stop. Define this parameter in the url.
options Tenant stop options. Define this parameter in the body.

Example

{
  "CallbackUrl": "sample string 1"
}

Response

Returns a job with information about the progress of the operation. Further calls to the jobs API can be made to get updated information about the status of the operation.

Example

{
  "Id": "ce03eae0-e155-42f6-bd42-1017c919f838",
  "Progress": 33,
  "Name": "Create Site",
  "Status": "Started",
  "Log": "Creating site...",
  "CallbackUrl": "https://mycallbackhandler.com/handle/site",
  "Jobs": 9,
  "CompletedJobs": 3,
  "StartedAt": "2021-10-16T02:19:06.4483303Z",
  "EndedAt": null,
  "Duration": "09:45:10.7238802",
  "Timestamp": "20211016021906448",
  "Tenant": null,
  "CreatedBy": {
    "Id": -2,
    "Email": "Api"
  },
  "HasEnded": false
}