Microsoft.DevCenter (stable:2025-02-01)

2025/02/13 • 61 new methods

DevBoxes_ListAllDevBoxes (new)
Description :  Lists Dev Boxes that the caller has access to in the DevCenter.
Reference :  Link ¶

⚼ Request

GET:  /devboxes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DevBox items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
}
,
}
,
}
DevCenter_ListProjects (new)
Description :  Lists all projects.
Reference :  Link ¶

⚼ Request

GET:  /projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Project items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the project. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
maxDevBoxesPerUser:
{
Description: When specified, indicates the maximum number of Dev Boxes a single user can create across all pools in the project. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of the pool. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
}
,
}
,
}
DevCenter_GetProject (new)
Description :  Gets a project.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
uri:
{
Description: The unique URI of the project. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
maxDevBoxesPerUser:
{
Description: When specified, indicates the maximum number of Dev Boxes a single user can create across all pools in the project. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of the pool. ,
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_ListCatalogsByProject (new)
Description :  Lists all of the catalogs available for a project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/catalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Catalog items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the catalog. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetCatalog (new)
Description :  Gets the specified catalog within the project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI of the catalog. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Name of the catalog. ,
Required: True ,
}
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_GetCustomizationTaskDefinitions (new)
Description :  Gets a customization task.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/catalogs/{catalogName}/customizationTasks/{taskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
taskName:
{
Description: Full name of the task: {catalogName}/{taskName}. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Full name of the task: {catalogName}/{taskName}. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog that the task belongs to. ,
Required: True ,
}
string ,
uri:
{
Description: The unique URI of the customization task. ,
Format: uri ,
Required: False ,
}
string ,
description:
{
Description: Description of the task. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the task. ,
Required: False ,
}
object ,
}

⚐ 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_ListEnvironmentDefinitionsByCatalog (new)
Description :  Lists all environment definitions available within a catalog.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/catalogs/{catalogName}/environmentDefinitions
{
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 ,
catalogName:
{
Description: The name of the catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnvironmentDefinition items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the environment definition. ,
Format: uri ,
Required: True ,
}
string ,
id:
{
Description: The ID of the environment definition. ,
Required: True ,
}
string ,
name:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter. ,
Required: True ,
}
string ,
name:
{
Description: Display name of the parameter. ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: Default value of the parameter. ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string). ,
Enum:
{
array: The parameter accepts an array of values. ,
boolean: The parameter accepts a boolean value. ,
integer: The parameter accepts an integer value. ,
number: The parameter accepts a number value. ,
object: The parameter accepts an object value. ,
string: The parameter accepts a string value. ,
}
,
Required: True ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required. ,
Required: True ,
}
boolean ,
allowed:
{
Description: An array of allowed values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
parametersSchema:
{
Description: JSON schema defining the parameters object passed to an environment. ,
Required: False ,
}
string ,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetEnvironmentDefinition (new)
Description :  Get an environment definition from a catalog.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
definitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI of the environment definition. ,
Format: uri ,
Required: True ,
}
string ,
id:
{
Description: The ID of the environment definition. ,
Required: True ,
}
string ,
name:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter. ,
Required: True ,
}
string ,
name:
{
Description: Display name of the parameter. ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: Default value of the parameter. ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string). ,
Enum:
{
array: The parameter accepts an array of values. ,
boolean: The parameter accepts a boolean value. ,
integer: The parameter accepts an integer value. ,
number: The parameter accepts a number value. ,
object: The parameter accepts an object value. ,
string: The parameter accepts a string value. ,
}
,
Required: True ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required. ,
Required: True ,
}
boolean ,
allowed:
{
Description: An array of allowed values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
parametersSchema:
{
Description: JSON schema defining the parameters object passed to an environment. ,
Required: False ,
}
string ,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
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_ListCustomizationTaskDefinitionsByProject (new)
Description :  Lists all customization tasks available to the project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/customizationTasks
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The CustomizationTaskDefinition items on this page ,
Required: True ,
}
[
{
name:
{
Description: Full name of the task: {catalogName}/{taskName}. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog that the task belongs to. ,
Required: True ,
}
string ,
uri:
{
Description: The unique URI of the customization task. ,
Format: uri ,
Required: False ,
}
string ,
description:
{
Description: Description of the task. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the task. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_ValidateCustomizationTasksAction (new)
Description :  Validates a list of customization tasks.
Reference :  Link ¶

⚼ 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 ,
}
,
}
,
}
,
}
Environments_ListEnvironmentDefinitionsByProject (new)
Description :  Lists all environment definitions available for a project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/environmentDefinitions
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The EnvironmentDefinition items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the environment definition. ,
Format: uri ,
Required: True ,
}
string ,
id:
{
Description: The ID of the environment definition. ,
Required: True ,
}
string ,
name:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter. ,
Required: True ,
}
string ,
name:
{
Description: Display name of the parameter. ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: Default value of the parameter. ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string). ,
Enum:
{
array: The parameter accepts an array of values. ,
boolean: The parameter accepts a boolean value. ,
integer: The parameter accepts an integer value. ,
number: The parameter accepts a number value. ,
object: The parameter accepts an object value. ,
string: The parameter accepts a string value. ,
}
,
Required: True ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required. ,
Required: True ,
}
boolean ,
allowed:
{
Description: An array of allowed values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
parametersSchema:
{
Description: JSON schema defining the parameters object passed to an environment. ,
Required: False ,
}
string ,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_ListEnvironmentTypes (new)
Description :  Lists all environment types configured for a project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/environmentTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnvironmentType items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the environment type. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Name of the environment type. ,
Required: True ,
}
string ,
deploymentTargetId:
{
Description: Id of a subscription or management group that the environment type will be mapped to. The environment's resources will be deployed into this subscription or management group. ,
Required: True ,
}
string ,
status:
{
Description: Indicates whether this environment type is enabled for use in this project. ,
Enum:
{
Enabled: The environment type is enabled for use in the project. ,
Disabled: The environment type is not enabled for use in the project. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the environment type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetEnvironmentTypes (new)
Description :  Get an environment type configured for a project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: Name of the environment type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI of the environment type. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Name of the environment type. ,
Required: True ,
}
string ,
deploymentTargetId:
{
Description: Id of a subscription or management group that the environment type will be mapped to. The environment's resources will be deployed into this subscription or management group. ,
Required: True ,
}
string ,
status:
{
Description: Indicates whether this environment type is enabled for use in this project. ,
Enum:
{
Enabled: The environment type is enabled for use in the project. ,
Disabled: The environment type is not enabled for use in the project. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the environment type. ,
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_GetEnvironmentTypeAbilities (new)
Description :  Gets the signed-in user's permitted abilities in an environment type.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/environmentTypes/{environmentTypeName}/users/{userId}/abilities
{
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 ,
environmentTypeName:
{
Description: The name of the environment type ,
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 ,
top:
{
Description: The maximum number of resources to return from the operation. Example: 'top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
abilitiesAsAdmin:
{
Description: The abilities the user has to perform actions on the environment type as an admin. ,
Required: True ,
}
[
string ,
]
,
abilitiesAsDeveloper:
{
Description: The abilities the user has to perform actions on the environment type as a developer. ,
Required: True ,
}
[
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_ListEnvironments (new)
Description :  Lists the environments for a project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/environments
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Environment items on this page ,
Required: True ,
}
[
{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters object for the environment. ,
Required: False ,
}
object ,
uri:
{
Description: The unique URI of the environment. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Environment name. ,
Required: True ,
}
string ,
environmentType:
{
Description: Environment type. ,
Required: True ,
}
string ,
user:
{
Description: The AAD object id of the owner of this Environment. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. ,
Enum:
{
Succeeded: The environment was successfully provisioned. ,
Failed: The environment failed to provision. ,
Canceled: The environment provisioning was canceled. ,
Creating: The environment is creating. ,
Accepted: The environment was accepted. ,
Deleting: The environment is deleting. ,
Updating: The environment is updating. ,
Preparing: The environment is preparing. ,
Running: The environment is running. ,
Syncing: The environment is Syncing. ,
MovingResources: The environment is moving resources. ,
TransientFailure: The environment has a transient failure. ,
StorageProvisioningFailed: The environment storage provisioning failed. ,
}
,
Required: False ,
}
enum ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
error:
{
Description: Provisioning error details. Populated only for error states. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetImagingTaskLog (new)
Description :  Gets the log for an imaging build task.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/imageBuildLogs/{imageBuildLogId}
{
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 ,
imageBuildLogId:
{
Description: An imaging build log id. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: 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 (new)
Description :  Get the status of an operation.
Reference :  Link ¶

⚼ 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_ListPools (new)
Description :  Lists available pools.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/pools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the pool. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Pool name. ,
Required: True ,
}
string ,
location:
{
Description: Azure region where Dev Boxes in the pool are located. ,
Required: True ,
}
string ,
osType:
{
Description: The operating system type of Dev Boxes in this pool. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
hardwareProfile:
{
Description: Hardware settings for the Dev Boxes created in this pool. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Storage settings for Dev Box created in this pool. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Image settings for Dev Boxes create in this pool. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
localAdministrator:
{
Description: Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
stopOnDisconnect:
{
Description: Stop on disconnect configuration settings for Dev Boxes created in this pool. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled. ,
Enum:
{
Enabled: Stop on disconnect is enabled on the Dev Box. ,
Disabled: Stop on disconnect is not enabled on the Dev Box. ,
}
,
Required: True ,
}
enum ,
gracePeriodMinutes:
{
Description: The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
stopOnNoConnect:
{
Description: Stop on no connect configuration settings for Dev Boxes created in this pool. ,
Required: False ,
}
{
status:
{
Description: Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. ,
Enum:
{
Enabled: Stop on no connect is enabled on the Dev Box. ,
Disabled: Stop on no connect is not enabled on the Dev Box. ,
}
,
Required: True ,
}
enum ,
gracePeriodMinutes:
{
Description: The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: The pool health status is not known. ,
Pending: The pool health status waiting for health checks to run. ,
Healthy: The pool health status is healthy. ,
Warning: The pool health status has one or more warnings. ,
Unhealthy: The pool health status is not healthy. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the pool. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetPool (new)
Description :  Gets a pool.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/pools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI of the pool. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Pool name. ,
Required: True ,
}
string ,
location:
{
Description: Azure region where Dev Boxes in the pool are located. ,
Required: True ,
}
string ,
osType:
{
Description: The operating system type of Dev Boxes in this pool. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
hardwareProfile:
{
Description: Hardware settings for the Dev Boxes created in this pool. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Storage settings for Dev Box created in this pool. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Image settings for Dev Boxes create in this pool. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
localAdministrator:
{
Description: Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
stopOnDisconnect:
{
Description: Stop on disconnect configuration settings for Dev Boxes created in this pool. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled. ,
Enum:
{
Enabled: Stop on disconnect is enabled on the Dev Box. ,
Disabled: Stop on disconnect is not enabled on the Dev Box. ,
}
,
Required: True ,
}
enum ,
gracePeriodMinutes:
{
Description: The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
stopOnNoConnect:
{
Description: Stop on no connect configuration settings for Dev Boxes created in this pool. ,
Required: False ,
}
{
status:
{
Description: Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. ,
Enum:
{
Enabled: Stop on no connect is enabled on the Dev Box. ,
Disabled: Stop on no connect is not enabled on the Dev Box. ,
}
,
Required: True ,
}
enum ,
gracePeriodMinutes:
{
Description: The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: The pool health status is not known. ,
Pending: The pool health status waiting for health checks to run. ,
Healthy: The pool health status is healthy. ,
Warning: The pool health status has one or more warnings. ,
Unhealthy: The pool health status is not healthy. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the pool. ,
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_ListSchedulesByPool (new)
Description :  Lists all schedules within a pool that are configured by your project administrator.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/pools/{poolName}/schedules
{
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 ,
poolName:
{
Description: The name of a pool of Dev Boxes. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the schedule. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Schedule. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource that this schedule belongs to. ,
Format: uri ,
Required: True ,
}
string ,
sourceType:
{
Description: The type of the resource that this schedule belongs to. ,
Enum:
{
Pool: The schedule source is a Dev Box pool. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Supported type this scheduled task represents. ,
Enum:
{
StopDevBox: The scheduled task will stop impacted Dev Boxes. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of this scheduled task. ,
Enum:
{
Daily: The scheduled task will run every day. ,
}
,
Required: True ,
}
enum ,
time:
{
Description: The target time to trigger the action. The format is HH:MM. ,
Required: True ,
}
string ,
timeZone:
{
Description: The IANA timezone id at which the schedule should execute. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetScheduleByPool (new)
Description :  Gets a schedule.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/pools/{poolName}/schedules/{scheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool name. ,
Required: True ,
}
string ,
scheduleName:
{
Description: Display name for the Schedule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI of the schedule. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Schedule. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource that this schedule belongs to. ,
Format: uri ,
Required: True ,
}
string ,
sourceType:
{
Description: The type of the resource that this schedule belongs to. ,
Enum:
{
Pool: The schedule source is a Dev Box pool. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Supported type this scheduled task represents. ,
Enum:
{
StopDevBox: The scheduled task will stop impacted Dev Boxes. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of this scheduled task. ,
Enum:
{
Daily: The scheduled task will run every day. ,
}
,
Required: True ,
}
enum ,
time:
{
Description: The target time to trigger the action. The format is HH:MM. ,
Required: True ,
}
string ,
timeZone:
{
Description: The IANA timezone id at which the schedule should execute. ,
Required: True ,
}
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_ListSchedulesByProject (new)
Description :  Lists all schedules within a project that are configured by your project administrator.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/schedules
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the schedule. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Schedule. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource that this schedule belongs to. ,
Format: uri ,
Required: True ,
}
string ,
sourceType:
{
Description: The type of the resource that this schedule belongs to. ,
Enum:
{
Pool: The schedule source is a Dev Box pool. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Supported type this scheduled task represents. ,
Enum:
{
StopDevBox: The scheduled task will stop impacted Dev Boxes. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of this scheduled task. ,
Enum:
{
Daily: The scheduled task will run every day. ,
}
,
Required: True ,
}
enum ,
time:
{
Description: The target time to trigger the action. The format is HH:MM. ,
Required: True ,
}
string ,
timeZone:
{
Description: The IANA timezone id at which the schedule should execute. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
}
,
}
,
}
DevCenter_GetProjectAbilities (new)
Description :  Gets the signed-in user's permitted abilities in a project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/abilities
{
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 ,
}

⚐ Response (200)

{
abilitiesAsAdmin:
{
Description: The abilities the user has to perform actions on the project as an admin. ,
Required: True ,
}
[
string ,
]
,
abilitiesAsDeveloper:
{
Description: The abilities the user has to perform actions on the project as a developer. ,
Required: True ,
}
[
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_ListDevBoxesByUser (new)
Description :  Lists Dev Boxes in the project for a particular user.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The DevBox items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetDevBoxByUser (new)
Description :  Gets a Dev Box.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}
{
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 (200)

{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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_CreateDevBox (new)
Description :  Creates or replaces a Dev Box.
Reference :  Link ¶

⚼ Request

PUT:  /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 ,
body:
{
Description: Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator ,
Required: True ,
}
{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of an instance of DevBox ,
}
string ,
operation-location: string ,
}
,
$schema:
{
Description: A Dev Box. ,
}
{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}
,
}

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

⚼ 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 (new)
Description :  Starts a Dev Box.
Reference :  Link ¶

⚼ 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 (new)
Description :  Stops a Dev Box.
Reference :  Link ¶

⚼ 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 (new)
Description :  Restarts a Dev Box.
Reference :  Link ¶

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

⚼ 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 (new)
Description :  Restores a Dev Box to a specified snapshot.
Reference :  Link ¶

⚼ 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 (new)
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 ¶

⚼ 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 ,
}
,
}
,
}
,
}
DevBoxes_ListActions (new)
Description :  Lists actions on a Dev Box.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions
{
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 (200)

{
value:
{
Description: The DevBoxAction items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI for the Dev Box action. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: The name of the action. ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Stop: The action will stop the Dev Box. ,
}
,
Required: True ,
}
enum ,
sourceId:
{
Description: The id of the resource which triggered this action. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource which triggered this action. ,
Format: uri ,
Required: True ,
}
string ,
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. ,
}
,
Required: True ,
}
enum ,
suspendedUntil:
{
Description: The earliest time that the action could occur (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetAction (new)
Description :  Gets an action.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}
{
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 ,
actionName:
{
Description: The name of the action. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI for the Dev Box action. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: The name of the action. ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Stop: The action will stop the Dev Box. ,
}
,
Required: True ,
}
enum ,
sourceId:
{
Description: The id of the resource which triggered this action. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource which triggered this action. ,
Format: uri ,
Required: True ,
}
string ,
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. ,
}
,
Required: True ,
}
enum ,
suspendedUntil:
{
Description: The earliest time that the action could occur (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
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_SkipAction (new)
Description :  Skips an occurrence of an action.
Reference :  Link ¶

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip
{
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 ,
actionName:
{
Description: The name of the action. ,
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 ,
}
,
}
,
}
,
}
DevBoxes_DelayAction (new)
Description :  Delays the occurrence of an action.
Reference :  Link ¶

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay
{
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 ,
actionName:
{
Description: The name of the action. ,
Required: True ,
}
string ,
until:
{
Description: The time to delay the Dev Box action or actions until, in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI for the Dev Box action. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: The name of the action. ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Stop: The action will stop the Dev Box. ,
}
,
Required: True ,
}
enum ,
sourceId:
{
Description: The id of the resource which triggered this action. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource which triggered this action. ,
Format: uri ,
Required: True ,
}
string ,
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. ,
}
,
Required: True ,
}
enum ,
suspendedUntil:
{
Description: The earliest time that the action could occur (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
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_DelayActions (new)
Description :  Delays all actions.
Reference :  Link ¶

⚼ Request

POST:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay
{
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 ,
until:
{
Description: The time to delay the Dev Box action or actions until, in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DevBoxActionDelayResult items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the action. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: The name of the action. ,
Required: True ,
}
string ,
result:
{
Description: The result of the delay operation on this action. ,
Enum:
{
Succeeded: The delay operation succeeded. ,
Failed: The delay operation failed. ,
}
,
Required: True ,
}
enum ,
action:
{
Description: The delayed action. ,
Required: False ,
}
{
uri:
{
Description: The unique URI for the Dev Box action. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: The name of the action. ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Stop: The action will stop the Dev Box. ,
}
,
Required: True ,
}
enum ,
sourceId:
{
Description: The id of the resource which triggered this action. ,
Required: True ,
}
string ,
sourceUri:
{
Description: The URI of the resource which triggered this action. ,
Format: uri ,
Required: True ,
}
string ,
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. ,
}
,
Required: True ,
}
enum ,
suspendedUntil:
{
Description: The earliest time that the action could occur (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
error:
{
Description: Information about the error that occurred. Only populated on error. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_ListCustomizationGroups (new)
Description :  Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups
{
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 ,
include:
{
Description: Optional query parameter to specify what properties should be included in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CustomizationGroup items on this page ,
Required: True ,
}
[
{
tasks:
{
Description: Tasks to apply. Note by default tasks are excluded from the response when listing customization groups. To include them, use the `include=tasks` query parameter. ,
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 ,
}
,
]
,
uri:
{
Description: The unique URI of the customization group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the customization group. ,
Required: True ,
}
string ,
status:
{
Description: Status of the customization group. ,
Enum:
{
NotStarted: The customization group has not yet started. ,
Running: The customization group is currently executing. ,
Succeeded: All tasks in the customization group successfully executed. ,
Failed: At least one task in the customization group failed. ,
ValidationFailed: At least one task in the customization group failed validation. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the customization group, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the customization group, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetCustomizationGroup (new)
Description :  Gets a customization group.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}
{
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 ,
customizationGroupName:
{
Description: Name of the customization group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tasks:
{
Description: Tasks to apply. Note by default tasks are excluded from the response when listing customization groups. To include them, use the `include=tasks` query parameter. ,
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 ,
}
,
]
,
uri:
{
Description: The unique URI of the customization group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the customization group. ,
Required: True ,
}
string ,
status:
{
Description: Status of the customization group. ,
Enum:
{
NotStarted: The customization group has not yet started. ,
Running: The customization group is currently executing. ,
Succeeded: All tasks in the customization group successfully executed. ,
Failed: At least one task in the customization group failed. ,
ValidationFailed: At least one task in the customization group failed validation. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the customization group, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the customization group, in RFC3339 format. ,
Format: date-time ,
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_CreateCustomizationGroup (new)
Description :  Applies customizations to the Dev Box.
Reference :  Link ¶

⚼ Request

PUT:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}
{
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 ,
customizationGroupName:
{
Description: A customization group name. ,
Required: True ,
}
string ,
body:
{
Description: Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator ,
Required: True ,
}
{
tasks:
{
Description: Tasks to apply. Note by default tasks are excluded from the response when listing customization groups. To include them, use the `include=tasks` query parameter. ,
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 ,
}
,
]
,
uri:
{
Description: The unique URI of the customization group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the customization group. ,
Required: True ,
}
string ,
status:
{
Description: Status of the customization group. ,
Enum:
{
NotStarted: The customization group has not yet started. ,
Running: The customization group is currently executing. ,
Succeeded: All tasks in the customization group successfully executed. ,
Failed: At least one task in the customization group failed. ,
ValidationFailed: At least one task in the customization group failed validation. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the customization group, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the customization group, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
tasks:
{
Description: Tasks to apply. Note by default tasks are excluded from the response when listing customization groups. To include them, use the `include=tasks` query parameter. ,
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 ,
}
,
]
,
uri:
{
Description: The unique URI of the customization group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the customization group. ,
Required: True ,
}
string ,
status:
{
Description: Status of the customization group. ,
Enum:
{
NotStarted: The customization group has not yet started. ,
Running: The customization group is currently executing. ,
Succeeded: All tasks in the customization group successfully executed. ,
Failed: At least one task in the customization group failed. ,
ValidationFailed: At least one task in the customization group failed validation. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the customization group, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the customization group, in RFC3339 format. ,
Format: date-time ,
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_GetCustomizationTaskLog (new)
Description :  Gets the log for a customization task.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}/logs/{customizationTaskId}
{
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 ,
customizationGroupName:
{
Description: A customization group name. ,
Required: True ,
}
string ,
customizationTaskId:
{
Description: A customization task ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: 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_ListOperations (new)
Description :  Lists operations on the Dev Box which have occurred within the past 90 days.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations
{
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 (200)

{
value:
{
Description: The DevBoxOperation items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI for the Dev Box operation. ,
Format: uri ,
Required: True ,
}
string ,
operationId:
{
Description: Unique identifier for the Dev Box operation. ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: The kind of operation that occurred. ,
Enum:
{
Start: The operation represents a Dev Box start. ,
Stop: The operation represents a Dev Box stop. ,
Restart: The operation represents a Dev Box restart. ,
Repair: The operation represents a Dev Box repair. ,
RestoreSnapshot: The operation represents a Dev Box restore from snapshot. ,
CaptureSnapshot: The operation represents a Dev Box manual snapshot creation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operation status. ,
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 ,
createdByObjectId:
{
Description: The object ID of the actor which initiated the operation. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: he time the operation started, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the operation finished, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or operation error details. Populated only for error states. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetOperation (new)
Description :  Gets an operation on a Dev Box.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}
{
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 ,
operationId:
{
Description: Unique identifier for the Dev Box operation. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI for the Dev Box operation. ,
Format: uri ,
Required: True ,
}
string ,
operationId:
{
Description: Unique identifier for the Dev Box operation. ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: The kind of operation that occurred. ,
Enum:
{
Start: The operation represents a Dev Box start. ,
Stop: The operation represents a Dev Box stop. ,
Restart: The operation represents a Dev Box restart. ,
Repair: The operation represents a Dev Box repair. ,
RestoreSnapshot: The operation represents a Dev Box restore from snapshot. ,
CaptureSnapshot: The operation represents a Dev Box manual snapshot creation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operation status. ,
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 ,
createdByObjectId:
{
Description: The object ID of the actor which initiated the operation. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: he time the operation started, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the operation finished, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or operation error details. Populated only for error states. ,
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_GetRemoteConnection (new)
Description :  Gets RDP Connection info.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection
{
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 (200)

{
webUrl:
{
Description: URL to open a browser based RDP session. ,
Format: uri ,
Required: False ,
}
string ,
rdpConnectionUrl:
{
Description: Link to open a Remote Desktop session. ,
Format: uri ,
Required: False ,
}
string ,
cloudPcConnectionUrl:
{
Description: Link to open a remote desktop session via a dev box's underlying Cloud PC (This will default to Windows App). ,
Format: uri ,
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_ListSnapshots (new)
Description :  Lists snapshots for this Dev Box.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots
{
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 (200)

{
value:
{
Description: The DevBoxSnapshot items on this page ,
Required: True ,
}
[
{
snapshotId:
{
Description: The id of the snapshot. Should be treated as opaque string. ,
Required: True ,
}
string ,
createdTime:
{
Description: The datetime that the snapshot was created, in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
expirationTime:
{
Description: The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
snapshotType:
{
Description: The type of the snapshot indicates whether it is manual or automatic. ,
Enum:
{
Manual: The snapshot type indicates that this is a manually taken snapshot. ,
Automatic: The snapshot type indicates that this is an automatically taken snapshot. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetSnapshot (new)
Description :  Gets a snapshot by snapshot id.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots/{snapshotId}
{
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: The id of the snapshot. Should be treated as opaque string. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
snapshotId:
{
Description: The id of the snapshot. Should be treated as opaque string. ,
Required: True ,
}
string ,
createdTime:
{
Description: The datetime that the snapshot was created, in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
expirationTime:
{
Description: The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
snapshotType:
{
Description: The type of the snapshot indicates whether it is manual or automatic. ,
Enum:
{
Manual: The snapshot type indicates that this is a manually taken snapshot. ,
Automatic: The snapshot type indicates that this is an automatically taken snapshot. ,
}
,
Required: True ,
}
enum ,
}

⚐ 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_ListEnvironmentsByUser (new)
Description :  Lists the environments for a project and user.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Environment items on this page ,
Required: True ,
}
[
{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters object for the environment. ,
Required: False ,
}
object ,
uri:
{
Description: The unique URI of the environment. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Environment name. ,
Required: True ,
}
string ,
environmentType:
{
Description: Environment type. ,
Required: True ,
}
string ,
user:
{
Description: The AAD object id of the owner of this Environment. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. ,
Enum:
{
Succeeded: The environment was successfully provisioned. ,
Failed: The environment failed to provision. ,
Canceled: The environment provisioning was canceled. ,
Creating: The environment is creating. ,
Accepted: The environment was accepted. ,
Deleting: The environment is deleting. ,
Updating: The environment is updating. ,
Preparing: The environment is preparing. ,
Running: The environment is running. ,
Syncing: The environment is Syncing. ,
MovingResources: The environment is moving resources. ,
TransientFailure: The environment has a transient failure. ,
StorageProvisioningFailed: The environment storage provisioning failed. ,
}
,
Required: False ,
}
enum ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
error:
{
Description: Provisioning error details. Populated only for error states. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetEnvironmentByUser (new)
Description :  Gets an environment.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters object for the environment. ,
Required: False ,
}
object ,
uri:
{
Description: The unique URI of the environment. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Environment name. ,
Required: True ,
}
string ,
environmentType:
{
Description: Environment type. ,
Required: True ,
}
string ,
user:
{
Description: The AAD object id of the owner of this Environment. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. ,
Enum:
{
Succeeded: The environment was successfully provisioned. ,
Failed: The environment failed to provision. ,
Canceled: The environment provisioning was canceled. ,
Creating: The environment is creating. ,
Accepted: The environment was accepted. ,
Deleting: The environment is deleting. ,
Updating: The environment is updating. ,
Preparing: The environment is preparing. ,
Running: The environment is running. ,
Syncing: The environment is Syncing. ,
MovingResources: The environment is moving resources. ,
TransientFailure: The environment has a transient failure. ,
StorageProvisioningFailed: The environment storage provisioning failed. ,
}
,
Required: False ,
}
enum ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
error:
{
Description: Provisioning error details. Populated only for error states. ,
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_CreateOrReplaceEnvironment (new)
Description :  Creates or updates an environment.
Reference :  Link ¶

⚼ Request

PUT:  /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 ,
body:
{
Description: Represents an environment. ,
Required: True ,
}
{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters object for the environment. ,
Required: False ,
}
object ,
uri:
{
Description: The unique URI of the environment. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Environment name. ,
Required: True ,
}
string ,
environmentType:
{
Description: Environment type. ,
Required: True ,
}
string ,
user:
{
Description: The AAD object id of the owner of this Environment. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. ,
Enum:
{
Succeeded: The environment was successfully provisioned. ,
Failed: The environment failed to provision. ,
Canceled: The environment provisioning was canceled. ,
Creating: The environment is creating. ,
Accepted: The environment was accepted. ,
Deleting: The environment is deleting. ,
Updating: The environment is updating. ,
Preparing: The environment is preparing. ,
Running: The environment is running. ,
Syncing: The environment is Syncing. ,
MovingResources: The environment is moving resources. ,
TransientFailure: The environment has a transient failure. ,
StorageProvisioningFailed: The environment storage provisioning failed. ,
}
,
Required: False ,
}
enum ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
error:
{
Description: Provisioning error details. Populated only for error states. ,
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 (201)

{
$headers:
{
operation-location: string ,
}
,
$schema:
{
Description: Properties of an environment. ,
}
{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters object for the environment. ,
Required: False ,
}
object ,
uri:
{
Description: The unique URI of the environment. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Environment name. ,
Required: True ,
}
string ,
environmentType:
{
Description: Environment type. ,
Required: True ,
}
string ,
user:
{
Description: The AAD object id of the owner of this Environment. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. ,
Enum:
{
Succeeded: The environment was successfully provisioned. ,
Failed: The environment failed to provision. ,
Canceled: The environment provisioning was canceled. ,
Creating: The environment is creating. ,
Accepted: The environment was accepted. ,
Deleting: The environment is deleting. ,
Updating: The environment is updating. ,
Preparing: The environment is preparing. ,
Running: The environment is running. ,
Syncing: The environment is Syncing. ,
MovingResources: The environment is moving resources. ,
TransientFailure: The environment has a transient failure. ,
StorageProvisioningFailed: The environment storage provisioning failed. ,
}
,
Required: False ,
}
enum ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
error:
{
Description: Provisioning error details. Populated only for error states. ,
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_PatchEnvironment (new)
Description :  Partially updates an environment.
Reference :  Link ¶

⚼ Request

PATCH:  /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 ,
body:
{
Description: Represents an environment. ,
Required: True ,
}
{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
expirationDate:
{
Description: The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters object for the environment. ,
Required: False ,
}
object ,
uri:
{
Description: The unique URI of the environment. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Environment name. ,
Required: True ,
}
string ,
environmentType:
{
Description: Environment type. ,
Required: True ,
}
string ,
user:
{
Description: The AAD object id of the owner of this Environment. ,
Format: uuid ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the environment. ,
Enum:
{
Succeeded: The environment was successfully provisioned. ,
Failed: The environment failed to provision. ,
Canceled: The environment provisioning was canceled. ,
Creating: The environment is creating. ,
Accepted: The environment was accepted. ,
Deleting: The environment is deleting. ,
Updating: The environment is updating. ,
Preparing: The environment is preparing. ,
Running: The environment is running. ,
Syncing: The environment is Syncing. ,
MovingResources: The environment is moving resources. ,
TransientFailure: The environment has a transient failure. ,
StorageProvisioningFailed: The environment storage provisioning failed. ,
}
,
Required: False ,
}
enum ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
catalogName:
{
Description: Name of the catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: Name of the environment definition. ,
Required: True ,
}
string ,
error:
{
Description: Provisioning error details. Populated only for error states. ,
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 (new)
Description :  Deletes an environment and all its associated resources
Reference :  Link ¶

⚼ 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 ,
}
,
}
,
}
,
}
Environments_ListActions (new)
Description :  Get all scheduled actions for a user within an environment.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}/actions
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnvironmentAction items on this page ,
Required: True ,
}
[
{
name:
{
Description: Uniquely identifies the action. ,
Required: True ,
}
string ,
uri:
{
Description: Uri of the action resource. ,
Format: uri ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Delete: The action will delete the environment and associated resources. ,
}
,
Required: True ,
}
enum ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastModifiedBy:
{
Description: Object Id of the user who last modified the action. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Time the object was last modified, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetAction (new)
Description :  Retrieve a specific environment action.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
actionName:
{
Description: Uniquely identifies the action. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Uniquely identifies the action. ,
Required: True ,
}
string ,
uri:
{
Description: Uri of the action resource. ,
Format: uri ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Delete: The action will delete the environment and associated resources. ,
}
,
Required: True ,
}
enum ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastModifiedBy:
{
Description: Object Id of the user who last modified the action. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Time the object was last modified, in RFC3339 format. ,
Format: date-time ,
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_SkipAction (new)
Description :  Skips an occurrence of an action.
Reference :  Link ¶

⚼ Request

POST:  /projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:skip
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
actionName:
{
Description: Uniquely identifies the action. ,
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 ,
}
,
}
,
}
,
}
Environments_DelayAction (new)
Description :  Delays the occurrence of an action.
Reference :  Link ¶

⚼ Request

POST:  /projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:delay
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
actionName:
{
Description: Uniquely identifies the action. ,
Required: True ,
}
string ,
until:
{
Description: The time to delay the Environment action until, in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Uniquely identifies the action. ,
Required: True ,
}
string ,
uri:
{
Description: Uri of the action resource. ,
Format: uri ,
Required: True ,
}
string ,
actionType:
{
Description: The action that will be taken. ,
Enum:
{
Delete: The action will delete the environment and associated resources. ,
}
,
Required: True ,
}
enum ,
next:
{
Description: Details about the next run of this action. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the action will be triggered (UTC), in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastModifiedBy:
{
Description: Object Id of the user who last modified the action. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Time the object was last modified, in RFC3339 format. ,
Format: date-time ,
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_ListOperations (new)
Description :  Lists operations on the environment which have occurred within the past 90 days
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnvironmentOperation items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI for the environment operation. ,
Format: uri ,
Required: True ,
}
string ,
operationId:
{
Description: Unique identifier for the environment operation. ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: The kind of operation that occurred. ,
Enum:
{
Deploy: The operation represents a deployment. ,
Delete: The operation represents a delete. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operation status. ,
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 ,
createdByObjectId:
{
Description: The object ID of the actor which initiated the operation. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: The time the operation started, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the operation finished, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
environmentParameters:
{
Description: Parameters object for the environment at the time of the operation. ,
Required: False ,
}
object ,
error:
{
Description: Provisioning or operation error details. Populated only for error states. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetOperation (new)
Description :  Gets an environment action result.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}
{
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 ,
environmentName:
{
Description: Environment name. ,
Required: True ,
}
string ,
operationId:
{
Description: Unique identifier for the environment operation. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uri:
{
Description: The unique URI for the environment operation. ,
Format: uri ,
Required: True ,
}
string ,
operationId:
{
Description: Unique identifier for the environment operation. ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: The kind of operation that occurred. ,
Enum:
{
Deploy: The operation represents a deployment. ,
Delete: The operation represents a delete. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operation status. ,
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 ,
createdByObjectId:
{
Description: The object ID of the actor which initiated the operation. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: The time the operation started, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the operation finished, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
environmentParameters:
{
Description: Parameters object for the environment at the time of the operation. ,
Required: False ,
}
object ,
error:
{
Description: Provisioning or operation error details. Populated only for error states. ,
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_GetLogsByOperation (new)
Description :  Gets the logs for an operation on an environment.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs
{
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 ,
operationId:
{
Description: The id of the operation on an environment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: 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_GetOutputs (new)
Description :  Gets Outputs from the environment.
Reference :  Link ¶

⚼ Request

GET:  /projects/{projectName}/users/{userId}/environments/{environmentName}/outputs
{
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 (200)

{
outputs:
{
Description: The outputs Names and Values. ,
Required: False ,
}
object ,
}

⚐ 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_ListAllDevBoxesByUser (new)
Description :  Lists Dev Boxes in the Dev Center for a particular user.
Reference :  Link ¶

⚼ Request

GET:  /users/{userId}/devboxes
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The DevBox items on this page ,
Required: True ,
}
[
{
uri:
{
Description: The unique URI of the dev box. ,
Format: uri ,
Required: True ,
}
string ,
name:
{
Description: Display name for the Dev Box. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project this Dev Box belongs to. ,
Required: False ,
}
string ,
poolName:
{
Description: The name of the Dev Box pool this machine belongs to. ,
Required: True ,
}
string ,
hibernateSupport:
{
Description: Indicates whether hibernate is enabled/disabled or unknown. ,
Enum:
{
Enabled: Hibernate is enabled. ,
Disabled: Hibernate is not enabled. ,
OsUnsupported: Hibernate is not supported by the operating system. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the Dev Box. ,
Enum:
{
Succeeded: Dev Box was successfully provisioned. ,
Failed: Dev Box failed to provision. ,
Canceled: Dev Box provision was canceled. ,
Creating: Dev Box is being created. ,
Deleting: Dev Box is being deleted. ,
Updating: Dev Box is updating. ,
Starting: Dev Box is starting. ,
Stopping: Dev Box is stopping. ,
Provisioning: Dev Box is provisioning. ,
ProvisionedWithWarning: Dev Box was provisioned with warning. ,
InGracePeriod: Dev Box is in grace period. ,
NotProvisioned: Dev Box is not provisioned. ,
}
,
Required: False ,
}
enum ,
actionState:
{
Description: The current action state of the Dev Box. This is state is based on previous action performed by user. ,
Required: False ,
}
string ,
powerState:
{
Description: The current power state of the Dev Box. ,
Enum:
{
Unknown: The Dev Box power state is not known. ,
Running: The Dev Box is running. ,
Deallocated: The Dev Box is deallocated. ,
PoweredOff: The Dev Box is powered off. ,
Hibernated: The Dev Box is hibernated. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Format: uuid ,
Required: False ,
}
string ,
error:
{
Description: Provisioning or action error details. Populated only for error states. ,
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 ,
}
,
}
,
location:
{
Description: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type of this Dev Box. ,
Enum:
{
Windows: The Windows operating system. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: The AAD object id of the user this Dev Box is assigned to. ,
Format: uuid ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Information about the Dev Box's hardware resources. ,
Required: False ,
}
{
skuName:
{
Description: The name of the SKU. ,
Enum:
{
general_i_8c32gb256ssd_v2: Intel, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_i_8c32gb512ssd_v2: Intel, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_i_8c32gb1024ssd_v2: Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_i_8c32gb2048ssd_v2: Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_i_16c64gb256ssd_v2: Intel, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_i_16c64gb512ssd_v2: Intel, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_i_16c64gb1024ssd_v2: Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_i_16c64gb2048ssd_v2: Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_i_32c128gb512ssd_v2: Intel, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_i_32c128gb1024ssd_v2: Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_i_32c128gb2048ssd_v2: Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
general_a_8c32gb256ssd_v2: AMD, 8 vCPU, 32 GB RAM, 256 GB Storage. ,
general_a_8c32gb512ssd_v2: AMD, 8 vCPU, 32 GB RAM, 512 GB Storage. ,
general_a_8c32gb1024ssd_v2: AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage. ,
general_a_8c32gb2048ssd_v2: AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage. ,
general_a_16c64gb256ssd_v2: AMD, 16 vCPU, 64 GB RAM, 256 GB Storage. ,
general_a_16c64gb512ssd_v2: AMD, 16 vCPU, 64 GB RAM, 512 GB Storage. ,
general_a_16c64gb1024ssd_v2: AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage. ,
general_a_16c64gb2048ssd_v2: AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage. ,
general_a_32c128gb512ssd_v2: AMD, 32 vCPU, 128 GB RAM, 512 GB Storage. ,
general_a_32c128gb1024ssd_v2: AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage. ,
general_a_32c128gb2048ssd_v2: AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage. ,
}
,
Required: False ,
}
enum ,
vCPUs:
{
Description: The number of vCPUs available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory available for the Dev Box. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageProfile:
{
Description: Storage settings for this Dev Box. ,
Required: False ,
}
{
osDisk:
{
Description: Settings for the operating system disk. ,
Required: False ,
}
{
diskSizeGB:
{
Description: The size of the OS Disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
imageReference:
{
Description: Information about the image used for this Dev Box. ,
Required: False ,
}
{
name:
{
Description: The name of the image used. ,
Required: False ,
}
string ,
version:
{
Description: The version of the image. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system of the image. ,
Required: False ,
}
string ,
osBuildNumber:
{
Description: The operating system build number of the image. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
createdTime:
{
Description: Creation time of this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectedTime:
{
Description: Last time a user connected to this Dev Box, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
localAdministrator:
{
Description: Indicates whether the owner of the Dev Box is a local administrator. ,
Enum:
{
Enabled: Owners of Dev Boxes in the pool are local administrators on the Dev Boxes. ,
Disabled: Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
}
,
}
,
}