Microsoft.DevCenter (preview:2024-10-01)

2025/02/13 • 10 updated methods

DevBoxes_ValidateCustomizationTasksAction (updated)
Description :  Validates a list of customization tasks.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_ValidateCustomizationTasksAction",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/customizationTasks:validateGroup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The DevCenter Project upon which to execute operations. ,
Required: True ,
}
string ,
body:
{
Description: Customization tasks to validate. ,
Required: True ,
}
{
tasks:
{
Description: Tasks to apply. ,
Required: False ,
}
[
{
name:
{
Description: Name of the task. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the task. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name to help differentiate multiple instances of the same task. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: Timeout, in seconds. Overrides any timeout provided on the task definition. ,
Format: int32 ,
Required: False ,
}
integer ,
runAs:
{
Description: What account to run the task as. ,
Enum:
{
System: The SYSTEM account. ,
User: The account of the signed in user. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of the task instance. ,
Required: False ,
}
string ,
logUri:
{
Description: The unique URI for retrieving the task logs. ,
Required: False ,
}
string ,
status:
{
Description: Status of the task. ,
Enum:
{
NotStarted: The task has not yet started. ,
Running: The task is currently executing. ,
Succeeded: The task successfully executed. ,
FailedValidation: The task reference is not valid. ,
Skipped: he task was skipped. ,
TimedOut: The task timed out. ,
Failed: The task failed to execute. ,
WaitingForUserInputUac: The task is awaiting the User Account Control (UAC) prompt to be approved. (See more at: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/) ,
WaitingForUserSession: The task is awaiting the user to connect to the Dev Box to execute. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the task, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
operation-location: string ,
}
,
$schema:
{
Description: The operation result of validating a list of customization tasks. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
result:
{
Description: Outcome of validation. ,
Required: False ,
}
{
validationResult:
{
Description: Outcome of validation. ,
Enum:
{
Succeeded: Validation succeeded. ,
Failed: Validation failed. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: List of validation errors. Absent if no errors. ,
Required: False ,
}
[
{
target:
{
Description: The customization task that the error is about. ,
Required: True ,
}
{
name:
{
Description: Name of the task. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the task. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name to help differentiate multiple instances of the same task. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: Timeout, in seconds. Overrides any timeout provided on the task definition. ,
Format: int32 ,
Required: False ,
}
integer ,
runAs:
{
Description: What account to run the task as. ,
Enum:
{
System: The SYSTEM account. ,
User: The account of the signed in user. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of the task instance. ,
Required: False ,
}
string ,
logUri:
{
Description: The unique URI for retrieving the task logs. ,
Required: False ,
}
string ,
status:
{
Description: Status of the task. ,
Enum:
{
NotStarted: The task has not yet started. ,
Running: The task is currently executing. ,
Succeeded: The task successfully executed. ,
FailedValidation: The task reference is not valid. ,
Skipped: he task was skipped. ,
TimedOut: The task timed out. ,
Failed: The task failed to execute. ,
WaitingForUserInputUac: The task is awaiting the User Account Control (UAC) prompt to be approved. (See more at: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/) ,
WaitingForUserSession: The task is awaiting the user to connect to the Dev Box to execute. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the task, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
details:
{
Description: List of validation errors for the task. ,
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 ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
OperationStatuses_Get (updated)
Description :  Get the status of an operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperationStatuses_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /projects/{projectName}/operationstatuses/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_DeleteDevBox (updated)
Description :  Deletes a Dev Box.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_DeleteDevBox",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The DevCenter Project upon which to execute operations. ,
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: The name of a Dev Box. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
operation-location: string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_StartDevBox (updated)
Description :  Starts a Dev Box.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_StartDevBox",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start
{
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 ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_StopDevBox (updated)
Description :  Stops a Dev Box.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_StopDevBox",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop
{
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 ,
hibernate:
{
Description: Optional parameter to hibernate the dev box. ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_RestartDevBox (updated)
Description :  Restarts a Dev Box.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_RestartDevBox",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart
{
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 ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_RepairDevBox (updated)
Description :  Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_RepairDevBox",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repair
{
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 ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_RestoreSnapshot (updated)
Description :  Restores a Dev Box to a specified snapshot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_RestoreSnapshot",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restoreSnapshot
{
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 ,
snapshotId:
{
Description: Required parameter that specifies the snapshot id to use for the restore operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
DevBoxes_CaptureSnapshot (updated)
Description :  Captures a manual snapshot of the Dev Box. Upon completion, a snapshotId will be generated. To retrieve all snapshots and their corresponding IDs, use the list snapshots endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DevBoxes_CaptureSnapshot",
  "Description": {
    "new": "Captures a manual snapshot of the Dev Box. \nUpon completion, a snapshotId will be generated. \nTo retrieve all snapshots and their corresponding IDs, use the list snapshots endpoint.",
    "old": "Captures a manual snapshot of the Dev Box."
  },
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}:captureSnapshot
{
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 ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Environments_DeleteEnvironment (updated)
Description :  Deletes an environment and all its associated resources
Reference :  Link ¶

⚶ Changes

{
  "#id": "Environments_DeleteEnvironment",
  "$responses": {
    "202": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /projects/{projectName}/users/{userId}/environments/{environmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The DevCenter Project upon which to execute operations. ,
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 ,
environmentName:
{
Description: The name of the environment. ,
Required: True ,
}
string ,
force:
{
Description: The query option to force environment deletion even if the environment definition does not exist. This is a best-effort delete, and anything custom that forces resource creation beyond the associated resource group may not be deleted. ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
operation-location: string ,
}
,
$schema:
{
Description: The current status of an async operation. ,
}
{
id:
{
Description: Fully qualified ID for the operation status. ,
Required: True ,
}
string ,
name:
{
Description: The operation id name. ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Provisioning state of the resource. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The id of the resource. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
error:
{
Description: Operation Error message. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}