Skip to content

[Microsoft.DevCenter] [Dataplane] New 2025-07-01-preview API version #35517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 67 additions & 1 deletion specification/devcenter/DevCenter/DevBox/models.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ union HibernateSupport {
string,
}

@doc("Indicates whether single sign on is enabled or disabled on the dev box.")
union SingleSignOnStatus {
@doc("The dev box is configured for single sign on.")
Enabled: "Enabled",

@doc("The dev box is not configured for single sign on.")
Disabled: "Disabled",

string,
}

@doc("Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.")
union LocalAdminStatus {
@doc("Owners of Dev Boxes in the pool are local administrators on the Dev Boxes.")
Expand Down Expand Up @@ -195,6 +206,14 @@ union PoolAlignTarget {
@doc("Network properties.")
NetworkProperties: "NetworkProperties",

@added(APIVersions.v2025_07_01_preview)
@doc("Hibernation support.")
HibernationSupport: "HibernationSupport",

@added(APIVersions.v2025_07_01_preview)
@doc("Single sign on status.")
SingleSignOnStatus: "SingleSignOnStatus",

string,
}

Expand Down Expand Up @@ -500,6 +519,10 @@ model Pool {
@doc("The default active hours configuration for Dev Boxes created in this pool.")
@added(APIVersions.v2025_04_01_preview)
activeHoursConfiguration?: PoolActiveHoursConfiguration;

@doc("Indicates whether single sign on is enabled/disabled or unknown.")
@added(APIVersions.v2025_07_01_preview)
singleSignOnStatus?: SingleSignOnStatus;
}

@doc("Hardware specifications for the Dev Box.")
Expand Down Expand Up @@ -600,6 +623,14 @@ model PoolActiveHoursConfiguration {

@doc("The default end time of the active hours.")
defaultEndTimeHour?: int32;

@doc("The days of the week that active hours features will be enabled.")
@added(APIVersions.v2025_07_01_preview)
defaultDaysOfWeek?: DayOfWeek[];

@doc("The maximum amount of days per week that a user can enable active hours related features.")
@added(APIVersions.v2025_07_01_preview)
daysOfWeekLimit?: int32;
}

@doc("The active hours configuration for a Dev Box.")
Expand Down Expand Up @@ -649,6 +680,36 @@ model UserActiveHoursConfiguration {

@doc("The end time of the active hours.")
endTimeHour?: int32;

@doc("The days of the week.")
@added(APIVersions.v2025_07_01_preview)
daysOfWeek?: DayOfWeek[];
}

#suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" "Days of week will never change."
@doc("Days of the week.")
@added(APIVersions.v2025_07_01_preview)
union DayOfWeek {
@doc("Monday")
Monday: "Monday",

@doc("Tuesday")
Tuesday: "Tuesday",

@doc("Wednesday")
Wednesday: "Wednesday",

@doc("Thursday")
Thursday: "Thursday",

@doc("Friday")
Friday: "Friday",

@doc("Saturday")
Saturday: "Saturday",

@doc("Sunday")
Sunday: "Sunday",
}

alias ScheduleListResult = Azure.Core.Page<Schedule>;
Expand Down Expand Up @@ -795,6 +856,11 @@ model DevBox {
@added(APIVersions.v2025_04_01_preview)
@visibility(Lifecycle.Read)
activeHoursConfiguration?: ActiveHoursConfiguration;

@doc("Indicates whether single sign on is enabled/disabled or unknown.")
@added(APIVersions.v2025_07_01_preview)
@visibility(Lifecycle.Read)
singleSignOnStatus?: SingleSignOnStatus;
}

@doc("Provides remote connection information for a Dev Box.")
Expand Down Expand Up @@ -1230,7 +1296,7 @@ model DevBoxTunnel extends DevBoxAddOn {
codeTunnelUrl: url;

@doc("""
The hosting resource name, either a DevBox or HyperV.
The hosting resource name, either a DevBox or HyperV.
Leaving it empty or `Default` if it's for DevBox.
""")
@visibility(Lifecycle.Read, Lifecycle.Create)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"title": "Aligns the dev box to the current pool network connection configuration.",
"operationId": "DevBoxes_AlignDevBox",
"parameters": {
"api-version": "2025-07-01-preview",
"endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com",
"projectName": "myProject",
"userId": "me",
"devBoxName": "MyDevBox",
"body": {
"targets": [
"NetworkProperties"
]
}
},
"responses": {
"202": {
"headers": {
"Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0"
},
"body": {
"id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"name": "786a823c-8037-48ab-89b8-8599901e67d0",
"status": "Running",
"startTime": "2023-02-01T12:43:54.122Z"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"title": "Aligns all Dev Boxes in the pool with the current configuration.",
"operationId": "DevBoxes_AlignPool",
"parameters": {
"api-version": "2025-07-01-preview",
"endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com",
"projectName": "myProject",
"poolName": "DevPool",
"body": {
"targets": [
"NetworkProperties"
]
}
},
"responses": {
"202": {
"headers": {
"Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0"
},
"body": {
"id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"name": "786a823c-8037-48ab-89b8-8599901e67d0",
"status": "Running",
"startTime": "2023-02-01T12:43:54.122Z"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"title": "Approves the creation of a Dev Box.",
"operationId": "DevBoxes_ApproveDevBox",
"parameters": {
"api-version": "2025-07-01-preview",
"endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com",
"projectName": "myProject",
"userId": "me",
"devBoxName": "MyDevBox"
},
"responses": {
"202": {
"headers": {
"Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0"
},
"body": {
"id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"name": "786a823c-8037-48ab-89b8-8599901e67d0",
"status": "Running",
"startTime": "2023-02-01T12:43:54.122Z"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"title": "Attempts to capture the manual snapshot for the Dev Box.",
"operationId": "DevBoxes_CaptureSnapshot",
"parameters": {
"api-version": "2025-07-01-preview",
"endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com",
"projectName": "myProject",
"userId": "me",
"devBoxName": "MyDevBox"
},
"responses": {
"202": {
"headers": {
"Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0"
},
"body": {
"id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"name": "786a823c-8037-48ab-89b8-8599901e67d0",
"status": "Running",
"startTime": "2023-02-01T12:43:54.122Z"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"title": "Applies customizations to the Dev Box.",
"operationId": "DevBoxes_CreateCustomizationGroup",
"parameters": {
"api-version": "2025-07-01-preview",
"endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/",
"projectName": "myProject",
"userId": "me",
"devBoxName": "MyDevBox",
"customizationGroupName": "Provisioning",
"body": {
"tasks": [
{
"name": "catalogName/choco",
"displayName": "Install VS Code",
"parameters": {
"packageName": "vscode",
"packageVersion": "1.0.0"
}
},
{
"name": "catalogName/write-to-file",
"runAs": "User"
}
]
}
},
"responses": {
"200": {
"body": {
"name": "Provisioning",
"uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning",
"tasks": [
{
"id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb",
"name": "catalogName/choco",
"displayName": "Install VS Code",
"status": "NotStarted",
"parameters": {
"packageName": "vscode",
"packageVersion": "1.0.0"
},
"logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb"
},
{
"id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4",
"name": "catalogName/write-to-file",
"runAs": "User",
"status": "NotStarted",
"logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4"
}
],
"status": "NotStarted"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
{
"title": "Creates or replaces a Dev Box.",
"operationId": "DevBoxes_CreateDevBox",
"parameters": {
"api-version": "2025-07-01-preview",
"endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com",
"projectName": "myProject",
"userId": "me",
"devBoxName": "MyDevBox",
"body": {
"poolName": "LargeDevWorkStationPool"
}
},
"responses": {
"200": {
"body": {
"uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox",
"name": "MyDevBox",
"provisioningState": "Succeeded",
"projectName": "ContosoProject",
"poolName": "LargeDevWorkStationPool",
"location": "centralus",
"osType": "Windows",
"user": "b08e39b4-2ac6-4465-a35e-48322efb0f98",
"hardwareProfile": {
"vCPUs": 8,
"memoryGB": 32
},
"storageProfile": {
"osDisk": {
"diskSizeGB": 1024
}
},
"hibernateSupport": "Enabled",
"imageReference": {
"name": "DevImage",
"version": "1.0.0",
"publishedDate": "2022-03-01T00:13:23.323Z"
}
}
},
"201": {
"headers": {
"Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
"Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0"
},
"body": {
"uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox",
"name": "MyDevBox",
"provisioningState": "Creating",
"projectName": "ContosoProject",
"poolName": "LargeDevWorkStationPool",
"location": "centralus",
"osType": "Windows",
"user": "b08e39b4-2ac6-4465-a35e-48322efb0f98",
"hardwareProfile": {
"vCPUs": 8,
"memoryGB": 32
},
"storageProfile": {
"osDisk": {
"diskSizeGB": 1024
}
},
"hibernateSupport": "Enabled",
"imageReference": {
"name": "DevImage",
"version": "1.0.0",
"publishedDate": "2022-03-01T00:13:23.323Z"
}
}
}
}
}
Loading
Loading