Microsoft.DevCenter (stable:2023-04-01)

2025/02/13 • 6 updated methods

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

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