Microsoft.DevCenter (preview:2025-08-01)

2025/08/29 • 1 updated methods

DevBoxes_ScheduleDeleteAction (updated)
Description :  Creates an action to schedule the deletion of a Dev Box
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_ScheduleDeleteAction",
  "$responses": {
    "@added_cd73f42a34434c65bccb6fc00463a862": {
      "#status": "204"
    },
    "@removed_d30c00860c2e4830a1465ff07ed9e138": {
      "200": {
        "Description": "An action which will take place on a Dev Box.",
        "Type": "object",
        "$properties": [
          {
            "#name": "uri",
            "Description": "The unique URI for the Dev Box action.",
            "Format": "uri",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The name of the action.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "actionType",
            "Description": "The action that will be taken.",
            "Enum": [
              [
                "Stop",
                "The action will stop the Dev Box."
              ],
              [
                "Delete",
                "The action will delete the Dev Box."
              ]
            ],
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "sourceId",
            "Description": "The id of the resource which triggered this action.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "sourceUri",
            "Description": "The URI of the resource which triggered this action.",
            "Format": "uri",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "sourceType",
            "Description": "The type of the resource which triggered this action.",
            "Enum": [
              [
                "Pool",
                "The action was triggered by a Dev Box pool."
              ],
              [
                "Schedule",
                "The action was triggered by a Dev Box schedule."
              ],
              [
                "Admin",
                "The action was triggered by a Dev Box admin."
              ],
              [
                "Project",
                "The action was triggered by a Project."
              ]
            ],
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "suspendedUntil",
            "Description": "The earliest time that the action could occur (UTC), in RFC3339 format.",
            "Format": "date-time",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "next",
            "Description": "Details about the next run of this action.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "scheduledTime",
                "Description": "The time the action will be triggered (UTC), in RFC3339 format.",
                "Format": "date-time",
                "Required": true,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:scheduleDelete
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
userId:
{
Description: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. ,
Required: True ,
}
string ,
devBoxName:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
deleteAt:
{
Description: The scheduled deletion time of the Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}