From bd1080bc0344675bac3c361adf37d29e17c7816f Mon Sep 17 00:00:00 2001 From: chrissmiller Date: Mon, 22 May 2023 18:09:57 -0400 Subject: [PATCH 01/23] Adds base for updating Microsoft.DevCenter from version preview/2023-01-01-preview to version 2023-07-01-preview --- .../preview/2023-07-01-preview/devbox.json | 1825 +++++++++++++++++ .../preview/2023-07-01-preview/devcenter.json | 341 +++ .../2023-07-01-preview/environments.json | 984 +++++++++ .../examples/Catalogs_Get.json | 15 + .../examples/Catalogs_ListByProject.json | 18 + .../examples/DevBoxActions_Delay.json | 24 + .../examples/DevBoxActions_DelayMultiple.json | 41 + .../DevBoxActions_DelayMultipleWithError.json | 36 + .../examples/DevBoxActions_Get.json | 22 + .../examples/DevBoxActions_List.json | 34 + .../examples/DevBoxActions_Skip.json | 13 + .../examples/DevBoxes_Create.json | 70 + .../examples/DevBoxes_Delete.json | 24 + .../examples/DevBoxes_Get.json | 37 + .../DevBoxes_GetRemoteConnection.json | 16 + .../examples/DevBoxes_List.json | 38 + .../DevBoxes_ListByUserByProject.json | 40 + .../examples/DevBoxes_Restart.json | 23 + .../examples/DevBoxes_Start.json | 23 + .../examples/DevBoxes_Stop.json | 24 + .../examples/EnvironmentDefinitions_Get.json | 55 + .../EnvironmentDefinitions_ListByCatalog.json | 65 + .../EnvironmentDefinitions_ListByProject.json | 64 + .../EnvironmentTypes_ListByProject.json | 20 + ...onments_CreateByEnvironmentDefinition.json | 38 + .../examples/Environments_Delete.json | 24 + .../examples/Environments_Get.json | 26 + .../examples/Environments_ListByProject.json | 28 + .../Environments_ListByProjectByUser.json | 29 + .../examples/Pools_Get.json | 37 + .../examples/Pools_List.json | 65 + .../examples/Projects_Get.json | 15 + .../examples/Projects_ListByDevCenter.json | 18 + .../examples/Schedules_Get.json | 20 + .../examples/Schedules_List.json | 23 + 35 files changed, 4175 insertions(+) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json new file mode 100644 index 000000000000..2d8307a3e87d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -0,0 +1,1825 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-01-01-preview", + "title": "DevCenter", + "description": "DevBox API." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "devcenter.json#/parameters/EndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/projects/{projectName}/pools": { + "get": { + "tags": [ + "Pools" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "description": "Lists available pools", + "operationId": "DevBoxes_ListPools", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListPools": { + "$ref": "./examples/Pools_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Pool" + } + }, + "/projects/{projectName}/pools/{poolName}": { + "get": { + "tags": [ + "Pools" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "description": "Gets a pool", + "operationId": "DevBoxes_GetPool", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetPool": { + "$ref": "./examples/Pools_Get.json" + } + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules": { + "get": { + "tags": [ + "Schedules" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "description": "Lists available schedules for a pool.", + "operationId": "DevBoxes_ListSchedulesByPool", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListSchedulesByPool": { + "$ref": "./examples/Schedules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "get": { + "tags": [ + "Schedules" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ScheduleNameParameter" + } + ], + "description": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetScheduleByPool": { + "$ref": "./examples/Schedules_Get.json" + } + } + } + }, + "/devboxes": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "description": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevCenter_ListAllDevBoxes", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevCenter_ListAllDevBoxes": { + "$ref": "./examples/DevBoxes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBox" + } + }, + "/users/{userId}/devboxes": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + } + ], + "description": "Lists Dev Boxes in the Dev Center for a particular user.", + "operationId": "DevCenter_ListAllDevBoxesByUser", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevCenter_ListAllDevBoxesByUser": { + "$ref": "./examples/DevBoxes_ListByUserByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBox" + } + }, + "/projects/{projectName}/users/{userId}/devboxes": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + } + ], + "description": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListDevBoxesByUser": { + "$ref": "./examples/DevBoxes_ListByUserByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBox" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Gets a Dev Box", + "operationId": "DevBoxes_GetDevBoxByUser", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetDevBoxByUser": { + "$ref": "./examples/DevBoxes_Get.json" + } + } + }, + "put": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a environment.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBox" + } + } + ], + "description": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_CreateDevBox": { + "$ref": "./examples/DevBoxes_Create.json" + } + } + }, + "delete": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_DeleteDevBox": { + "$ref": "./examples/DevBoxes_Delete.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Starts a Dev Box", + "operationId": "DevBoxes_StartDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_StartDevBox": { + "$ref": "./examples/DevBoxes_Start.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/HibernateParameter" + } + ], + "description": "Stops a Dev Box", + "operationId": "DevBoxes_StopDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_StopDevBox": { + "$ref": "./examples/DevBoxes_Stop.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Restarts a Dev Box", + "operationId": "DevBoxes_RestartDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_StartDevBox": { + "$ref": "./examples/DevBoxes_Restart.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Gets RDP Connection info", + "operationId": "DevBoxes_GetRemoteConnection", + "responses": { + "200": { + "description": "The request completed successfully.", + "schema": { + "$ref": "#/definitions/RemoteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetRemoteConnection": { + "$ref": "./examples/DevBoxes_GetRemoteConnection.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions": { + "get": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxActionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListActions": { + "$ref": "./examples/DevBoxActions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBoxAction" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}": { + "get": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionNameParameter" + } + ], + "description": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetAction": { + "$ref": "./examples/DevBoxActions_Get.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip": { + "post": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionNameParameter" + } + ], + "description": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "responses": { + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_SkipAction": { + "$ref": "./examples/DevBoxActions_Skip.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay": { + "post": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionDelayUntilParameter" + } + ], + "description": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_DelayAction": { + "$ref": "./examples/DevBoxActions_Delay.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay": { + "post": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionDelayUntilParameter" + } + ], + "description": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxActionsDelayMultipleResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_DelayActions": { + "$ref": "./examples/DevBoxActions_DelayMultiple.json" + }, + "DevBoxes_DelayActionsWithError": { + "$ref": "./examples/DevBoxActions_DelayMultipleWithError.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBoxActionDelayResult" + } + } + }, + "definitions": { + "PoolListResult": { + "type": "object", + "description": "The Pool list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "Pool": { + "type": "object", + "description": "A pool of Dev Boxes.", + "properties": { + "name": { + "type": "string", + "description": "Pool name" + }, + "location": { + "description": "Azure region where Dev Boxes in the pool are located", + "type": "string" + }, + "osType": { + "description": "The operating system type of Dev Boxes in this pool", + "$ref": "#/definitions/OsType" + }, + "hardwareProfile": { + "description": "Hardware settings for the Dev Boxes created in this pool", + "$ref": "#/definitions/HardwareProfile" + }, + "hibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "$ref": "#/definitions/HibernateSupport" + }, + "storageProfile": { + "description": "Storage settings for Dev Box created in this pool", + "$ref": "#/definitions/StorageProfile" + }, + "imageReference": { + "description": "Image settings for Dev Boxes create in this pool", + "$ref": "#/definitions/ImageReference" + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes.", + "$ref": "#/definitions/LocalAdminStatus" + }, + "stopOnDisconnect": { + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnDisconnectConfiguration" + }, + "healthStatus": { + "description": "Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.", + "$ref": "#/definitions/PoolHealthStatus" + } + }, + "required": [ + "name", + "location", + "healthStatus" + ] + }, + "PoolHealthStatus": { + "description": "Pool status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "name": "PoolHealthStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "The pool health status is not known." + }, + { + "value": "Pending", + "description": "The pool health status waiting for health checks to run." + }, + { + "value": "Healthy", + "description": "The pool health status is healthy." + }, + { + "value": "Warning", + "description": "The pool health status has one or more warnings." + }, + { + "value": "Unhealthy", + "description": "The pool health status is not healthy." + } + ] + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.", + "enum": [ + "Enabled", + "Disabled", + "OsUnsupported" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Hibernate is enabled." + }, + { + "value": "Disabled", + "description": "Hibernate is not enabled." + }, + { + "value": "OsUnsupported", + "description": "Hibernate is not supported by the operating system." + } + ] + } + }, + "LocalAdminStatus": { + "description": "Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Owners of Dev Boxes in the pool are local administrators on the Dev Boxes." + }, + { + "value": "Disabled", + "description": "Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes." + } + ] + } + }, + "StopOnDisconnectEnableStatus": { + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Stop on disconnect is enabled on the Dev Box." + }, + { + "value": "Disabled", + "description": "Stop on disconnect is not enabled on the Dev Box." + } + ] + } + }, + "ScheduleListResult": { + "type": "object", + "description": "The Schedule list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "Schedule": { + "type": "object", + "description": "A Schedule to execute action.", + "properties": { + "name": { + "description": "Display name for the Schedule", + "type": "string" + }, + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledType" + }, + "frequency": { + "description": "The frequency of this scheduled task.", + "$ref": "#/definitions/ScheduledFrequency" + }, + "time": { + "description": "The target time to trigger the action. The format is HH:MM.", + "type": "string" + }, + "timeZone": { + "description": "The IANA timezone id at which the schedule should execute.", + "type": "string" + } + }, + "required": [ + "name", + "type", + "frequency", + "time", + "timeZone" + ] + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true, + "values": [ + { + "value": "StopDevBox", + "description": "The scheduled task will stop impacted Dev Boxes." + } + ] + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true, + "values": [ + { + "value": "Daily", + "description": "The scheduled task will run every day." + } + ] + } + }, + "DevBoxListResult": { + "type": "object", + "description": "The Dev Box list result", + "properties": { + "value": { + "description": "The list of DevBox Dev Boxes", + "type": "array", + "items": { + "$ref": "#/definitions/DevBox" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBox": { + "type": "object", + "description": "A Dev Box", + "properties": { + "name": { + "description": "Display name for the Dev Box", + "type": "string", + "readOnly": true + }, + "projectName": { + "description": "Name of the project this Dev Box belongs to", + "type": "string", + "readOnly": true + }, + "poolName": { + "description": "The name of the Dev Box pool this machine belongs to.", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "$ref": "#/definitions/HibernateSupport", + "readOnly": true + }, + "provisioningState": { + "description": "The current provisioning state of the Dev Box.", + "type": "string", + "readOnly": true + }, + "actionState": { + "description": "The current action state of the Dev Box. This is state is based on previous action performed by user.", + "type": "string", + "readOnly": true + }, + "powerState": { + "description": "The current power state of the Dev Box.", + "$ref": "#/definitions/PowerState", + "readOnly": true + }, + "uniqueId": { + "description": "A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "type": "string", + "readOnly": true + }, + "error": { + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true, + "$ref": "devcenter.json#/definitions/CloudErrorBody" + }, + "location": { + "description": "Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The operating system type of this Dev Box.", + "$ref": "#/definitions/OsType", + "readOnly": true + }, + "user": { + "type": "string", + "description": "The AAD object id of the user this Dev Box is assigned to.", + "readOnly": true + }, + "hardwareProfile": { + "description": "Information about the Dev Box's hardware resources", + "$ref": "#/definitions/HardwareProfile", + "readOnly": true + }, + "storageProfile": { + "description": "Storage settings for this Dev Box", + "$ref": "#/definitions/StorageProfile", + "readOnly": true + }, + "imageReference": { + "description": "Information about the image used for this Dev Box", + "$ref": "#/definitions/ImageReference", + "readOnly": true + }, + "createdTime": { + "description": "Creation time of this Dev Box", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "localAdministrator": { + "description": "Indicates whether the owner of the Dev Box is a local administrator.", + "$ref": "#/definitions/LocalAdminStatus" + } + }, + "required": [ + "poolName" + ] + }, + "OsType": { + "type": "string", + "enum": [ + "Windows" + ], + "description": "The operating system type.", + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "value": "Windows", + "description": "The Windows operating system." + } + ] + } + }, + "HardwareProfile": { + "description": "Hardware specifications for the Dev Box.", + "type": "object", + "properties": { + "skuName": { + "description": "The name of the SKU", + "type": "string", + "readOnly": true + }, + "vCPUs": { + "description": "The number of vCPUs available for the Dev Box.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memoryGB": { + "description": "The amount of memory available for the Dev Box.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "StorageProfile": { + "type": "object", + "description": "Storage settings for the Dev Box's disks", + "properties": { + "osDisk": { + "$ref": "#/definitions/OSDisk" + } + } + }, + "OSDisk": { + "type": "object", + "description": "Settings for the operating system disk.", + "properties": { + "diskSizeGB": { + "description": "The size of the OS Disk in gigabytes.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ImageReference": { + "description": "Specifies information about the image used", + "type": "object", + "properties": { + "name": { + "description": "The name of the image used.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the image.", + "type": "string", + "readOnly": true + }, + "operatingSystem": { + "description": "The operating system of the image.", + "type": "string", + "readOnly": true + }, + "osBuildNumber": { + "description": "The operating system build number of the image.", + "type": "string", + "readOnly": true + }, + "publishedDate": { + "description": "The datetime that the backing image version was published.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "RemoteConnection": { + "description": "Provides remote connection information for a Dev Box.", + "type": "object", + "properties": { + "webUrl": { + "description": "URL to open a browser based RDP session.", + "type": "string" + }, + "rdpConnectionUrl": { + "description": "Link to open a Remote Desktop session.", + "type": "string" + } + } + }, + "PowerState": { + "type": "string", + "enum": [ + "Unknown", + "Running", + "Deallocated", + "PoweredOff", + "Hibernated" + ], + "description": "The power states of a Dev Box.", + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "The Dev Box power state is not known." + }, + { + "value": "Running", + "description": "The Dev Box is running." + }, + { + "value": "Deallocated", + "description": "The Dev Box is deallocated." + }, + { + "value": "PoweredOff", + "description": "The Dev Box is powered off." + }, + { + "value": "Hibernated", + "description": "The Dev Box is hibernated." + } + ] + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.", + "$ref": "#/definitions/StopOnDisconnectEnableStatus" + }, + "gracePeriodMinutes": { + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "status" + ] + }, + "DevBoxActionsDelayMultipleResult": { + "type": "object", + "description": "The actions list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxActionDelayResult" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBoxActionDelayResult": { + "type": "object", + "description": "The action delay result", + "properties": { + "name": { + "type": "string", + "description": "The name of the action." + }, + "result": { + "$ref": "#/definitions/DevBoxActionDelayResultStatus", + "description": "The result of the delay operation on this action." + }, + "action": { + "description": "The delayed action", + "type": "object", + "$ref": "#/definitions/DevBoxAction" + }, + "error": { + "description": "Information about the error that occurred. Only populated on error.", + "type": "object", + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "name", + "result" + ] + }, + "DevBoxActionDelayResultStatus": { + "type": "string", + "enum": [ + "Succeeded", + "Failed" + ], + "description": "The result of the delay operation on this action.", + "x-ms-enum": { + "name": "DevBoxActionDelayResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The delay operation succeeded." + }, + { + "value": "Failed", + "description": "The delay operation failed." + } + ] + } + }, + "DevBoxActionsListResult": { + "type": "object", + "description": "The actions list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBoxAction": { + "type": "object", + "description": "An action which will take place on a Dev Box.", + "properties": { + "name": { + "description": "The name of the action.", + "type": "string" + }, + "actionType": { + "description": "The action that will be taken.", + "$ref": "#/definitions/DevBoxActionType" + }, + "sourceId": { + "description": "The id of the resource which triggered this action", + "type": "string" + }, + "suspendedUntil": { + "description": "The earliest time that the action could occur (UTC).", + "type": "string", + "format": "date-time" + }, + "next": { + "description": "Details about the next run of this action.", + "$ref": "#/definitions/DevBoxNextAction" + } + }, + "required": [ + "name", + "actionType", + "sourceId" + ] + }, + "DevBoxActionType": { + "description": "The type of action which will take place on a Dev Box.", + "type": "string", + "enum": [ + "Stop" + ], + "x-ms-enum": { + "name": "DevBoxActionType", + "modelAsString": true, + "values": [ + { + "value": "Stop", + "description": "The action will stop the Dev Box." + } + ] + } + }, + "DevBoxNextAction": { + "description": "Details about the next run of an action.", + "type": "object", + "properties": { + "scheduledTime": { + "description": "The time the action will be triggered (UTC).", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "scheduledTime" + ] + } + }, + "parameters": { + "PoolNameParameter": { + "name": "poolName", + "description": "The name of a pool of Dev Boxes.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "in": "path", + "x-ms-parameter-location": "method" + }, + "ScheduleNameParameter": { + "name": "scheduleName", + "description": "The name of a schedule.", + "required": true, + "type": "string", + "in": "path", + "x-ms-parameter-location": "method" + }, + "DevBoxNameParameter": { + "name": "devBoxName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of a Dev Box.", + "x-ms-parameter-location": "method" + }, + "HibernateParameter": { + "name": "hibernate", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to hibernate the dev box.", + "x-ms-parameter-location": "method" + }, + "DevBoxActionNameParameter": { + "name": "actionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of an action that will take place on a Dev Box.", + "x-ms-parameter-location": "method" + }, + "DevBoxActionDelayUntilParameter": { + "name": "until", + "description": "The time to delay the Dev Box action or actions until.", + "required": true, + "type": "string", + "format": "date-time", + "in": "query", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json new file mode 100644 index 000000000000..716a4799a397 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json @@ -0,0 +1,341 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-01-01-preview", + "title": "DevCenter" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "devcenter.json#/parameters/EndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "operationId": "DevCenter_ListProjects", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenter_ListProjects": { + "$ref": "./examples/Projects_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "description": "Gets a project.", + "parameters": [ + { + "$ref": "#/parameters/ProjectNameMethodParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "operationId": "DevCenter_GetProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenter_GetProject": { + "$ref": "./examples/Projects_Get.json" + } + } + } + } + }, + "definitions": { + "ProjectListResult": { + "description": "Results of the project list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "Project": { + "description": "Project details.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the project" + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "When specified, indicates the maximum number of Dev Boxes a single user can create across all pools in the project." + } + }, + "required": [ + "name" + ] + }, + "CloudError": { + "x-ms-external": true, + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "description": "Error body", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "description": "An error response from the service.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ID for the operation status.", + "type": "string" + }, + "name": { + "description": "The operation id name", + "type": "string" + }, + "status": { + "description": "Provisioning state of the resource.", + "type": "string" + }, + "resourceId": { + "description": "The id of the resource.", + "type": "string" + }, + "startTime": { + "description": "The start time of the operation", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation", + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "description": "Percent of the operation that is complete", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation.", + "type": "object" + }, + "error": { + "description": "Operation Error message", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + } + }, + "required": [ + "status" + ] + } + }, + "parameters": { + "ProjectNameParameter": { + "name": "projectName", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "in": "path", + "x-ms-parameter-location": "client" + }, + "ProjectNameMethodParameter": { + "name": "projectName", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63, + "in": "path", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request.", + "x-ms-parameter-location": "client" + }, + "FilterParameter": { + "name": "filter", + "in": "query", + "description": "An OData filter clause to apply to the operation.", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: 'top=10'.", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "required": true, + "x-ms-client-default": "me", + "type": "string", + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$", + "minLength": 2, + "maxLength": 36, + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "description": "The DevCenter-specific URI to operate on.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json new file mode 100644 index 000000000000..b75c9f05df20 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -0,0 +1,984 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-01-01-preview", + "title": "DevCenter", + "description": "Deployment Environments API." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "devcenter.json#/parameters/EndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/projects/{projectName}/environments": { + "get": { + "tags": [ + "Environments" + ], + "description": "Lists the environments for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "operationId": "Environments_ListEnvironments", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironments": { + "$ref": "./examples/Environments_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments": { + "get": { + "tags": [ + "Environments" + ], + "description": "Lists the environments for a project and user.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + } + ], + "operationId": "Environments_ListEnvironmentsByUser", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentsByUser": { + "$ref": "./examples/Environments_ListByProjectByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}": { + "get": { + "tags": [ + "Environments" + ], + "description": "Gets an environment", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "Environments_GetEnvironmentByUser", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetEnvironmentByUser": { + "$ref": "./examples/Environments_Get.json" + } + } + }, + "put": { + "tags": [ + "Environments" + ], + "description": "Creates or updates an environment.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "operationId": "Environments_CreateOrReplaceEnvironment", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_CreateByEnvironmentDefinition": { + "$ref": "./examples/Environments_CreateByEnvironmentDefinition.json" + } + } + }, + "delete": { + "tags": [ + "Environments" + ], + "description": "Deletes an environment and all its associated resources", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "Environments_DeleteEnvironment", + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "Deletion was successful or resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_DeleteEnvironment": { + "$ref": "./examples/Environments_Delete.json" + } + } + } + }, + "/projects/{projectName}/catalogs": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Lists all of the catalogs available for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListCatalogsByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListCatalogsByProject": { + "$ref": "./examples/Catalogs_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Gets the specified catalog within the project", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Environments_GetCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetCatalog": { + "$ref": "./examples/Catalogs_Get.json" + } + } + } + }, + "/projects/{projectName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists all environment definitions available for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentDefinitions": { + "$ref": "./examples/EnvironmentDefinitions_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists all environment definitions available within a catalog.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentDefinitionsByCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Get an environment definition from a catalog.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "operationId": "Environments_GetEnvironmentDefinition", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetEnvironmentDefinition": { + "$ref": "./examples/EnvironmentDefinitions_Get.json" + } + } + } + }, + "/projects/{projectName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists all environment types configured for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListEnvironmentTypes", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentTypes": { + "$ref": "./examples/EnvironmentTypes_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "EnvironmentUpdateProperties": { + "description": "Properties of an environment. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "parameters": { + "type": "object", + "description": "Parameters object for the environment." + } + } + }, + "Environment": { + "description": "Properties of an environment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateProperties" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Environment name.", + "readOnly": true + }, + "environmentType": { + "type": "string", + "description": "Environment type.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "user": { + "type": "string", + "description": "The AAD object id of the owner of this Environment.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the environment.", + "type": "string", + "readOnly": true + }, + "resourceGroupId": { + "description": "The identifier of the resource group containing the environment's resources.", + "type": "string", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "environmentDefinitionName": { + "type": "string", + "description": "Name of the environment definition.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "error": { + "description": "Provisioning error details. Populated only for error states.", + "readOnly": true, + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "environmentType", + "catalogName", + "environmentDefinitionName" + ] + }, + "EnvironmentListResult": { + "description": "Results of the environment list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Environment" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "CatalogListResult": { + "description": "Results of the catalog list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "Catalog": { + "description": "A catalog.", + "type": "object", + "properties": { + "name": { + "description": "Name of the catalog.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "EnvironmentDefinitionListResult": { + "description": "Results of the environment definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "EnvironmentDefinition": { + "description": "An environment definition.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the environment definition.", + "type": "string" + }, + "name": { + "description": "Name of the environment definition.", + "type": "string" + }, + "catalogName": { + "description": "Name of the catalog.", + "type": "string" + }, + "description": { + "description": "A short description of the environment definition.", + "type": "string" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + }, + "description": "Input parameters passed to an environment." + }, + "parametersSchema": { + "type": "string", + "description": "JSON schema defining the parameters object passed to an environment." + }, + "templatePath": { + "description": "Path to the Environment Definition entrypoint file.", + "type": "string" + } + }, + "required": [ + "name", + "catalogName", + "id" + ] + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter" + }, + "name": { + "type": "string", + "description": "Display name of the parameter" + }, + "description": { + "type": "string", + "description": "Description of the parameter" + }, + "default": { + "type": "string", + "description": "Default value of the parameter" + }, + "type": { + "description": "A string of one of the basic JSON types (number, integer, array, object, boolean, string)", + "$ref": "#/definitions/ParameterType" + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a value." + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required" + }, + "allowed": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1, + "uniqueItems": true, + "description": "An array of allowed values" + } + }, + "required": [ + "id", + "type", + "required" + ] + }, + "EnvironmentTypeListResult": { + "description": "Result of the environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "EnvironmentType": { + "description": "Properties of an environment type.", + "type": "object", + "properties": { + "name": { + "description": "Name of the environment type", + "type": "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.", + "type": "string" + }, + "status": { + "description": "Indicates whether this environment type is enabled for use in this project.", + "$ref": "#/definitions/EnvironmentTypeEnableStatus" + } + }, + "required": [ + "name", + "deploymentTargetId", + "status" + ] + }, + "EnvironmentTypeEnableStatus": { + "description": "Indicates whether an environment type is enabled for use in a project.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "The environment type is enabled for use in the project." + }, + { + "value": "Disabled", + "description": "The environment type is not enabled for use in the project." + } + ] + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "description": "The type of data a parameter accepts.", + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + } + }, + "parameters": { + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the environment.", + "x-ms-parameter-location": "method" + }, + "CatalogNameParameter": { + "name": "catalogName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the catalog", + "x-ms-parameter-location": "method" + }, + "EnvironmentDefinitionNameParameter": { + "name": "definitionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the environment definition", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json new file mode 100644 index 000000000000..46decb6e0b5d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json new file mode 100644 index 000000000000..3232b1b6981b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json new file mode 100644 index 000000000000..0f3b18e44c5f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json new file mode 100644 index 000000000000..dfb9eab4c3d4 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "schedule-default", + "result": "Succeeded", + "action": { + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json new file mode 100644 index 000000000000..215fe67ccd03 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "schedule-default", + "result": "Failed", + "error": { + "code": "DelayOverMaxTime", + "message": "The schedule cannot be delayed more than 8 hours from the original invocation time." + } + }, + { + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json new file mode 100644 index 000000000000..dce28def4598 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json new file mode 100644 index 000000000000..b267a2452534 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json new file mode 100644 index 000000000000..129f5240f0fe --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json new file mode 100644 index 000000000000..f2231bae09e9 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-01-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": { + "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": { + "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" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json new file mode 100644 index 000000000000..2c6caaeee854 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-01-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" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json new file mode 100644 index 000000000000..dd775479dc10 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "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" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..da39d43b46b8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json new file mode 100644 index 000000000000..c72d4174feb5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "api-version": "2023-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "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" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json new file mode 100644 index 000000000000..ab148cbda829 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "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" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json new file mode 100644 index 000000000000..67becab4dade --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-01-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" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json new file mode 100644 index 000000000000..67becab4dade --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-01-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" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json new file mode 100644 index 000000000000..a91bf73b8b81 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "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" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json new file mode 100644 index 000000000000..f41e2ec3cdf2 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json new file mode 100644 index 000000000000..a72dc8cfe587 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json new file mode 100644 index 000000000000..52c01ea43057 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json new file mode 100644 index 000000000000..7cd86e3ecbca --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json new file mode 100644 index 000000000000..152bd360fb58 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + } + } + }, + "responses": { + "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": { + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json new file mode 100644 index 000000000000..1a3f8947af2c --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "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" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json new file mode 100644 index 000000000000..d70a87592d1e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json new file mode 100644 index 000000000000..e46cdc41996f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json new file mode 100644 index 000000000000..203d857c920f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..4131207e4fcb --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2023-01-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "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" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..be5753166f52 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2023-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "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" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy" + }, + { + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json new file mode 100644 index 000000000000..c98fe177a261 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "name": "DevDiv", + "description": "The developer division" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json new file mode 100644 index 000000000000..eab762f07305 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DevDiv", + "description": "The developer division" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json new file mode 100644 index 000000000000..0104d665de03 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2023-01-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json new file mode 100644 index 000000000000..430acbe20aed --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2023-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} From d71c9f7d11b6088b8c720daa5fe1f9fcc216f55f Mon Sep 17 00:00:00 2001 From: chrissmiller Date: Mon, 22 May 2023 18:10:01 -0400 Subject: [PATCH 02/23] Updates readme --- specification/devcenter/data-plane/readme.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 626d01f8301e..7a03901927a9 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -27,14 +27,25 @@ These are the global settings for the devcenter. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-2023-01-01-preview +tag: package-preview-2023-07 ``` + +### Tag: package-preview-2023-07 + +These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-07' +input-file: + - Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json + - Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json + - Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +``` ### Tag: 2023-04-01 These settings apply only when `--tag=package-2023-04-01` is specified on the command line. -```yaml $(tag) == 'package-2023-04-01' +``` yaml $(tag) == 'package-2023-04-01' input-file: - Microsoft.DevCenter/stable/2023-04-01/devbox.json - Microsoft.DevCenter/stable/2023-04-01/devcenter.json @@ -49,7 +60,7 @@ directive: These settings apply only when `--tag=package-2023-01-01-preview` is specified on the command line. -```yaml $(tag) == 'package-2023-01-01-preview' +``` yaml $(tag) == 'package-2023-01-01-preview' input-file: - Microsoft.DevCenter/preview/2023-01-01-preview/devbox.json - Microsoft.DevCenter/preview/2023-01-01-preview/devcenter.json @@ -59,6 +70,7 @@ directive: - suppress: HostParametersValidation reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen ``` + ### Tag: package-preview-2022-11 These settings apply only when `--tag=package-preview-2022-11` is specified on the command line. From e6259588a522e58288f2aef2de09847799a1cf64 Mon Sep 17 00:00:00 2001 From: chrissmiller Date: Mon, 22 May 2023 18:10:08 -0400 Subject: [PATCH 03/23] Updates API version in new specs and examples --- .../Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json | 2 +- .../preview/2023-07-01-preview/devcenter.json | 2 +- .../preview/2023-07-01-preview/environments.json | 2 +- .../preview/2023-07-01-preview/examples/Catalogs_Get.json | 2 +- .../2023-07-01-preview/examples/Catalogs_ListByProject.json | 2 +- .../2023-07-01-preview/examples/DevBoxActions_Delay.json | 2 +- .../examples/DevBoxActions_DelayMultiple.json | 2 +- .../examples/DevBoxActions_DelayMultipleWithError.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxActions_Get.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxActions_List.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxActions_Skip.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_Create.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_Delete.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_Get.json | 2 +- .../examples/DevBoxes_GetRemoteConnection.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_List.json | 2 +- .../examples/DevBoxes_ListByUserByProject.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_Restart.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_Start.json | 2 +- .../preview/2023-07-01-preview/examples/DevBoxes_Stop.json | 2 +- .../2023-07-01-preview/examples/EnvironmentDefinitions_Get.json | 2 +- .../examples/EnvironmentDefinitions_ListByCatalog.json | 2 +- .../examples/EnvironmentDefinitions_ListByProject.json | 2 +- .../examples/EnvironmentTypes_ListByProject.json | 2 +- .../examples/Environments_CreateByEnvironmentDefinition.json | 2 +- .../2023-07-01-preview/examples/Environments_Delete.json | 2 +- .../preview/2023-07-01-preview/examples/Environments_Get.json | 2 +- .../2023-07-01-preview/examples/Environments_ListByProject.json | 2 +- .../examples/Environments_ListByProjectByUser.json | 2 +- .../preview/2023-07-01-preview/examples/Pools_Get.json | 2 +- .../preview/2023-07-01-preview/examples/Pools_List.json | 2 +- .../preview/2023-07-01-preview/examples/Projects_Get.json | 2 +- .../2023-07-01-preview/examples/Projects_ListByDevCenter.json | 2 +- .../preview/2023-07-01-preview/examples/Schedules_Get.json | 2 +- .../preview/2023-07-01-preview/examples/Schedules_List.json | 2 +- 35 files changed, 35 insertions(+), 35 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 2d8307a3e87d..7605a8225c0f 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01-preview", + "version": "2023-07-01-preview", "title": "DevCenter", "description": "DevBox API." }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json index 716a4799a397..6499679f2b4f 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01-preview", + "version": "2023-07-01-preview", "title": "DevCenter" }, "x-ms-parameterized-host": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index b75c9f05df20..d4810d2a4a2d 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01-preview", + "version": "2023-07-01-preview", "title": "DevCenter", "description": "Deployment Environments API." }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json index 46decb6e0b5d..806ebffe3524 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "catalogName": "foo" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json index 3232b1b6981b..62376660db48 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json index 0f3b18e44c5f..5d232db67233 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json index dfb9eab4c3d4..08b5649acb41 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json index 215fe67ccd03..e7604eddaf65 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json index dce28def4598..761ac697de08 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json index b267a2452534..731350aec87e 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json index 129f5240f0fe..64a618f0b5f6 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Skip.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json index f2231bae09e9..0440ffd30377 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json index 2c6caaeee854..86a11d672028 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Delete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json index dd775479dc10..e5fbce51a379 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json index da39d43b46b8..9d886ef62f86 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRemoteConnection.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json index c72d4174feb5..a2d7aa000ee6 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json @@ -1,7 +1,7 @@ { "parameters": { "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", - "api-version": "2023-01-01-preview" + "api-version": "2023-07-01-preview" }, "responses": { "200": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json index ab148cbda829..3f8419b42551 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json index 67becab4dade..23ce58f2e141 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Restart.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json index 67becab4dade..23ce58f2e141 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Start.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json index a91bf73b8b81..985ba6e01d67 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Stop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json index f41e2ec3cdf2..59d8e902edfa 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "catalogName": "myCatalog", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json index a72dc8cfe587..6041cfd8ec5f 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "catalogName": "myCatalog" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json index 52c01ea43057..4f42e9cc5d53 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json index 7cd86e3ecbca..e78d94356646 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json index 152bd360fb58..a8c8f46e55fd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "environmentName": "mydevenv", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json index 1a3f8947af2c..61da3d7695c0 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Delete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json index d70a87592d1e..beb8b7481ae0 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json index e46cdc41996f..1694e082eb42 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json index 203d857c920f..4f7349bb1a3a 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "userId": "me" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json index 4131207e4fcb..77142384d13c 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "poolName": "DevPool" }, "responses": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json index be5753166f52..cd7525b8c3bd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", - "api-version": "2023-01-01-preview" + "api-version": "2023-07-01-preview" }, "responses": { "200": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json index c98fe177a261..0be500dac210 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json index eab762f07305..28ce89a62bcf 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" }, "responses": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json index 0104d665de03..aea890773d6a 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", - "api-version": "2023-01-01-preview", + "api-version": "2023-07-01-preview", "poolName": "DevPool", "scheduleName": "default" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json index 430acbe20aed..42130765494a 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json @@ -3,7 +3,7 @@ "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", "projectName": "myProject", "poolName": "DevPool", - "api-version": "2023-01-01-preview" + "api-version": "2023-07-01-preview" }, "responses": { "200": { From 309bc2fc6fa30384b561168e67ac30737a0a22b2 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:27:10 -0400 Subject: [PATCH 04/23] Add schedule and troubleshoot APIs, add generic id property, update examples --- .../preview/2023-07-01-preview/devbox.json | 132 ++++++++++++++++++ .../examples/Catalogs_Get.json | 1 + .../examples/Catalogs_ListByProject.json | 1 + .../examples/DevBoxActions_Delay.json | 1 + .../examples/DevBoxActions_DelayMultiple.json | 2 + .../DevBoxActions_DelayMultipleWithError.json | 2 + .../examples/DevBoxActions_Get.json | 1 + .../examples/DevBoxActions_List.json | 2 + .../examples/DevBoxes_Create.json | 2 + .../examples/DevBoxes_Get.json | 1 + .../examples/DevBoxes_List.json | 1 + .../DevBoxes_ListByUserByProject.json | 1 + .../examples/Pools_Get.json | 1 + .../examples/Pools_List.json | 2 + .../examples/Projects_Get.json | 1 + .../examples/Projects_ListByDevCenter.json | 1 + .../examples/Schedules_Get.json | 2 + .../examples/Schedules_List.json | 2 + .../examples/Schedules_ListByProject.json | 25 ++++ 19 files changed, 181 insertions(+) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 7605a8225c0f..dca3fd93b0fc 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -139,6 +139,58 @@ } } }, + "/projects/{projectName}/schedules": { + "get": { + "tags": [ + "Schedules" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "description": "Lists available schedules for all resources within a project.", + "operationId": "DevBoxes_ListSchedulesByProject", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListSchedulesByProject": { + "$ref": "./examples/Schedules_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Schedule" + } + }, "/projects/{projectName}/pools/{poolName}/schedules": { "get": { "tags": [ @@ -747,6 +799,61 @@ } } }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:troubleshoot": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Troubleshoot a Dev Box", + "operationId": "DevBoxes_TroubleshootDevBox", + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_TroubleshootDevBox": { + "$ref": "./examples/DevBoxes_Troubleshoot.json" + } + } + } + }, "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { "get": { "tags": [ @@ -1084,6 +1191,10 @@ "type": "object", "description": "A pool of Dev Boxes.", "properties": { + "id": { + "description": "The ID of the pool", + "type": "string" + }, "name": { "type": "string", "description": "Pool name" @@ -1126,6 +1237,7 @@ } }, "required": [ + "id", "name", "location", "healthStatus" @@ -1263,10 +1375,18 @@ "type": "object", "description": "A Schedule to execute action.", "properties": { + "id": { + "description": "The ID of the schedule", + "type": "string" + }, "name": { "description": "Display name for the Schedule", "type": "string" }, + "sourceId": { + "description": "The id of the resource that this schedule belongs to", + "type": "string" + }, "type": { "description": "Supported type this scheduled task represents.", "$ref": "#/definitions/ScheduledType" @@ -1285,7 +1405,9 @@ } }, "required": [ + "id", "name", + "sourceId", "type", "frequency", "time", @@ -1350,6 +1472,11 @@ "type": "object", "description": "A Dev Box", "properties": { + "id": { + "description": "The ID of the dev box", + "type": "string", + "readOnly": true + }, "name": { "description": "Display name for the Dev Box", "type": "string", @@ -1702,6 +1829,11 @@ "type": "object", "description": "An action which will take place on a Dev Box.", "properties": { + "id": { + "description": "Unique identifier for the dev box action within a dev center", + "type": "string", + "readOnly": true + }, "name": { "description": "The name of the action.", "type": "string" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json index 806ebffe3524..f1e47b9d3e1b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json @@ -8,6 +8,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/catalogs/foo", "name": "foo" } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json index 62376660db48..bb1fe429e03b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json @@ -9,6 +9,7 @@ "body": { "value": [ { + "id": "/projects/myProject/catalogs/foo", "name": "foo" } ] diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json index 5d232db67233..7e4598babd7e 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json @@ -11,6 +11,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json index 08b5649acb41..c9f682d800d1 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json @@ -12,6 +12,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", "name": "schedule-default", "result": "Succeeded", "action": { @@ -25,6 +26,7 @@ } }, { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "result": "Succeeded", "action": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json index e7604eddaf65..fe7b55509e1f 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json @@ -12,6 +12,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", "name": "schedule-default", "result": "Failed", "error": { @@ -20,6 +21,7 @@ } }, { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "result": "Succeeded", "action": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json index 761ac697de08..9dc5f4cd1d9d 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json @@ -10,6 +10,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json index 731350aec87e..0597dbbec62f 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json @@ -11,6 +11,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", @@ -19,6 +20,7 @@ } }, { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json index 0440ffd30377..c5b17ea7e487 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json @@ -12,6 +12,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", "name": "MyDevBox", "provisioningState": "Succeeded", "projectName": "ContosoProject", @@ -42,6 +43,7 @@ "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/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", "name": "MyDevBox", "provisioningState": "Creating", "projectName": "ContosoProject", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json index e5fbce51a379..966fa35a9ded 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json @@ -9,6 +9,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", "name": "MyDevBox", "provisioningState": "Succeeded", "projectName": "ContosoProject", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json index a2d7aa000ee6..296df830da96 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json @@ -8,6 +8,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", "name": "MyDevBox", "provisioningState": "Succeeded", "projectName": "ContosoProject", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json index 3f8419b42551..3eae4d6a29fd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json @@ -10,6 +10,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", "name": "MyDevBox", "provisioningState": "Succeeded", "projectName": "ContosoProject", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json index 77142384d13c..917d816911ab 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json @@ -8,6 +8,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/pools/LargeDevWorkStationPool", "name": "LargeDevWorkStationPool", "location": "centralus", "osType": "Windows", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json index cd7525b8c3bd..0516fddf6da3 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json @@ -9,6 +9,7 @@ "body": { "value": [ { + "id": "/projects/myProject/pools/LargeDevWorkStationPool", "name": "LargeDevWorkStationPool", "location": "centralus", "osType": "Windows", @@ -34,6 +35,7 @@ "healthStatus": "Healthy" }, { + "id": "/projects/myProject/pools/SQLDevelopmentMachinePool", "name": "SQLDevelopmentMachinePool", "location": "southcentralus", "osType": "Windows", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json index 0be500dac210..5d0e545c9e80 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json @@ -7,6 +7,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject", "name": "DevDiv", "description": "The developer division" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json index 28ce89a62bcf..78609c5713a8 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json @@ -8,6 +8,7 @@ "body": { "value": [ { + "id": "/projects/myProject", "name": "DevDiv", "description": "The developer division" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json index aea890773d6a..3d76098114da 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json @@ -9,7 +9,9 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/pools/DevPool/schedules/default", "name": "default", + "sourceId": "/projects/myProject/pools/DevPool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", "frequency": "Daily", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json index 42130765494a..38252e4d2a3a 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json @@ -10,7 +10,9 @@ "body": { "value": [ { + "id": "/projects/myProject/pools/DevPool/schedules/default", "name": "default", + "sourceId": "/projects/myProject/pools/DevPool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", "frequency": "Daily", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json new file mode 100644 index 000000000000..9b3df3d11d38 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceId": "/projects/myProject/pools/DevPool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } + } + \ No newline at end of file From d78211ed36e6b07fc1296b0eae2f08a7e69651e5 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:27:59 -0400 Subject: [PATCH 05/23] Add troubleshoot example and update environment examples --- .../examples/DevBoxes_Troubleshoot.json | 23 +++++++++++++++++++ .../EnvironmentTypes_ListByProject.json | 1 + ...onments_CreateByEnvironmentDefinition.json | 1 + .../examples/Environments_Get.json | 1 + .../examples/Environments_ListByProject.json | 1 + .../Environments_ListByProjectByUser.json | 1 + 6 files changed, 28 insertions(+) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Troubleshoot.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Troubleshoot.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Troubleshoot.json new file mode 100644 index 000000000000..23ce58f2e141 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Troubleshoot.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-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" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json index e78d94356646..078b7f8d4d3e 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json @@ -9,6 +9,7 @@ "body": { "value": [ { + "id": "/projects/myProject/environmentTypes/devtestenv", "name": "devtestenv", "status": "Enabled", "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json index a8c8f46e55fd..16ff8a19682b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json @@ -22,6 +22,7 @@ "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/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json index beb8b7481ae0..9d9f95f03948 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json @@ -9,6 +9,7 @@ "responses": { "200": { "body": { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json index 1694e082eb42..7501f84fef35 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json @@ -9,6 +9,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json index 4f7349bb1a3a..d1502e450b04 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json @@ -10,6 +10,7 @@ "body": { "value": [ { + "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", From 82923900a626ffc13571e5a788c77d3b793abfd9 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:28:37 -0400 Subject: [PATCH 06/23] Add ID to project --- .../preview/2023-07-01-preview/devcenter.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json index 6499679f2b4f..da80a10c7cf4 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json @@ -145,6 +145,10 @@ "description": "Project details.", "type": "object", "properties": { + "id": { + "description": "The ID of the project", + "type": "string" + }, "name": { "type": "string", "description": "Name of the project" @@ -161,6 +165,7 @@ } }, "required": [ + "id", "name" ] }, From 742db3e4cc4b6085eb2a7bd5cedf5202ca39db5e Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:32:43 -0400 Subject: [PATCH 07/23] Add environment operations API --- .../2023-07-01-preview/environments.json | 250 ++++++++++++++++++ ...nvironmentOperations_GetByEnvironment.json | 27 ++ .../EnvironmentOperations_GetLogs.json | 15 ++ ...vironmentOperations_ListByEnvironment.json | 30 +++ 4 files changed, 322 insertions(+) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index d4810d2a4a2d..4fe209894326 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -310,6 +310,157 @@ } } }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { + "get": { + "tags": [ + "Operations", + "Environments" + ], + "description": "Lists the operations for an environment.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "EnvironmentOperations_ListByEnvironment", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "EnvironmentOperations_ListByEnvironment": { + "$ref": "./examples/EnvironmentOperations_ListByEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationName}": { + "get": { + "tags": [ + "Operations", + "Environments" + ], + "description": "Gets an environment operation.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentOperationNameParameter" + } + ], + "operationId": "EnvironmentOperations_GetByEnvironment", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "EnvironmentOperations_GetByEnvironment": { + "$ref": "./examples/EnvironmentOperations_GetByEnvironment.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationName}/logs": { + "get": { + "tags": [ + "Operations", + "Environments" + ], + "description": "Gets an environment operations logs.", + "produces": [ + "text/plain" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentOperationNameParameter" + } + ], + "operationId": "EnvironmentOperations_GetLogs", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "type": "string", + "format": "byte" + } + } + }, + "x-ms-examples": { + "EnvironmentOperations_GetLogs": { + "$ref": "./examples/EnvironmentOperations_GetLogs.json" + } + } + } + }, "/projects/{projectName}/catalogs": { "get": { "tags": [ @@ -619,6 +770,11 @@ } ], "properties": { + "id": { + "description": "The ID of the environment", + "type": "string", + "readOnly": true + }, "name": { "type": "string", "description": "Environment name.", @@ -719,12 +875,17 @@ "description": "A catalog.", "type": "object", "properties": { + "id": { + "description": "The ID of the catalog", + "type": "string" + }, "name": { "description": "Name of the catalog.", "type": "string" } }, "required": [ + "id", "name" ] }, @@ -862,6 +1023,10 @@ "description": "Properties of an environment type.", "type": "object", "properties": { + "id": { + "description": "The ID of the environment type", + "type": "string" + }, "name": { "description": "Name of the environment type", "type": "string" @@ -876,6 +1041,7 @@ } }, "required": [ + "id", "name", "deploymentTargetId", "status" @@ -944,6 +1110,79 @@ } ] } + }, + "EnvironmentOperationListResult": { + "type": "object", + "description": "The operations list result.", + "properties": { + "value": { + "description": "The current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "EnvironmentOperation": { + "type": "object", + "description": "An operation on an environment.", + "properties": { + "id": { + "description": "Unique identifier for the environment operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the operation.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of operation that was taken.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The operation status.", + "type": "string", + "readOnly": true + }, + "parameters": { + "type": "object", + "description": "Parameters object for the operation.", + "readOnly": true + }, + "createdByObjectId": { + "description": "The object ID of the actor which initiated the operation'.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "The time the operation started.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "error": { + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true, + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + } } }, "parameters": { @@ -979,6 +1218,17 @@ "maxLength": 63, "description": "The name of the environment definition", "x-ms-parameter-location": "method" + }, + "EnvironmentOperationNameParameter": { + "name": "operationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the operation.", + "x-ms-parameter-location": "method" } } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json new file mode 100644 index 000000000000..75f69cc70664 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/users/me/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "name": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Failed", + "type": "Deploy", + "parameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json new file mode 100644 index 000000000000..e65107362320 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "This is an example log output." + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json new file mode 100644 index 000000000000..ac83e7c4a10a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/projects/myProject/users/me/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "name": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Failed", + "type": "Deploy", + "parameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} From 8fe0c8a74173d300db7aeef8ac6a1e0732c889c2 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:36:47 -0400 Subject: [PATCH 08/23] Re-add last operation ID --- .../preview/2023-07-01-preview/devbox.json | 5 +++++ .../preview/2023-07-01-preview/examples/DevBoxes_Get.json | 3 ++- .../preview/2023-07-01-preview/examples/DevBoxes_List.json | 3 ++- .../examples/DevBoxes_ListByUserByProject.json | 3 ++- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index dca3fd93b0fc..02d7e3b0d240 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1567,6 +1567,11 @@ "localAdministrator": { "description": "Indicates whether the owner of the Dev Box is a local administrator.", "$ref": "#/definitions/LocalAdminStatus" + }, + "lastOperationId": { + "description": "The ID of the most recent operation performed on the Dev Box.", + "readOnly": true, + "type": "string" } }, "required": [ diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json index 966fa35a9ded..ed9b88956826 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json @@ -31,7 +31,8 @@ "name": "DevImage", "version": "1.0.0", "publishedDate": "2022-03-01T00:13:23.323Z" - } + }, + "lastOperationId": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" } } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json index 296df830da96..c4c3c86929c3 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json @@ -30,7 +30,8 @@ "name": "DevImage", "version": "1.0.0", "publishedDate": "2022-03-01T00:13:23.323Z" - } + }, + "lastOperationId": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" } ] } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json index 3eae4d6a29fd..ec89f8262544 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json @@ -32,7 +32,8 @@ "name": "DevImage", "version": "1.0.0", "publishedDate": "2022-03-01T00:13:23.323Z" - } + }, + "lastOperationId": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" } ] } From 7f196db5c25020cec892fc09adbb6c77a14be52c Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:46:39 -0400 Subject: [PATCH 09/23] Run prettier --- .../examples/Schedules_ListByProject.json | 41 +++++++++---------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json index 9b3df3d11d38..0e257cd4f1b4 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json @@ -1,25 +1,24 @@ { - "parameters": { - "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", - "projectName": "myProject", - "api-version": "2023-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/projects/myProject/pools/DevPool/schedules/default", - "name": "default", - "sourceId": "/projects/myProject/pools/DevPool", - "type": "StopDevBox", - "timeZone": "America/Los_Angeles", - "frequency": "Daily", - "time": "17:30" - } - ] - } + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceId": "/projects/myProject/pools/DevPool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] } } } - \ No newline at end of file +} From a862abed55eb4a98bf6cadaf3dffaa1d602655e6 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 10:48:26 -0400 Subject: [PATCH 10/23] Add ID to delay result --- .../preview/2023-07-01-preview/devbox.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 02d7e3b0d240..1937cbfa52dc 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1764,6 +1764,11 @@ "type": "object", "description": "The action delay result", "properties": { + "id": { + "description": "Unique identifier for the dev box action within a dev center", + "type": "string", + "readOnly": true + }, "name": { "type": "string", "description": "The name of the action." From cff68ae18eae26d5f05b383d1d2759fdf12b736e Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 5 Jun 2023 13:08:15 -0400 Subject: [PATCH 11/23] Add suppression for host parameters validation --- specification/devcenter/data-plane/readme.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 7a03901927a9..1be206a5b3bb 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -27,19 +27,23 @@ These are the global settings for the devcenter. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-preview-2023-07 +tag: package-2023-07-01-preview ``` -### Tag: package-preview-2023-07 +### Tag: package-2023-07-01-preview -These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. +These settings apply only when `--tag=package-2023-07-01-preview` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-07' +```yaml $(tag) == 'package-2023-07-01-preview' input-file: - Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json - Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json - Microsoft.DevCenter/preview/2023-07-01-preview/environments.json + +directive: + - suppress: HostParametersValidation + reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen ``` ### Tag: 2023-04-01 From 5b6f0db16b397e6341d0b4878d4f0d8f4b93f9b4 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 12 Jun 2023 14:32:30 -0400 Subject: [PATCH 12/23] Remove last operation ID --- .../preview/2023-07-01-preview/devbox.json | 96 +++++++++++++++++-- .../2023-07-01-preview/environments.json | 78 +++++++-------- .../examples/DevBoxes_Get.json | 3 +- .../examples/DevBoxes_GetRepairResult.json | 20 ++++ .../examples/DevBoxes_List.json | 3 +- .../DevBoxes_ListByUserByProject.json | 3 +- ...Troubleshoot.json => DevBoxes_Repair.json} | 0 ...onmentActionResults_GetByEnvironment.json} | 6 +- ... => EnvironmentActionResults_GetLogs.json} | 2 +- ...nmentActionResults_ListByEnvironment.json} | 4 +- 10 files changed, 154 insertions(+), 61 deletions(-) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json rename specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/{DevBoxes_Troubleshoot.json => DevBoxes_Repair.json} (100%) rename specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/{EnvironmentOperations_GetByEnvironment.json => EnvironmentActionResults_GetByEnvironment.json} (83%) rename specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/{EnvironmentOperations_GetLogs.json => EnvironmentActionResults_GetLogs.json} (85%) rename specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/{EnvironmentOperations_ListByEnvironment.json => EnvironmentActionResults_ListByEnvironment.json} (90%) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 1937cbfa52dc..a1dcd4dcc1c9 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -799,7 +799,7 @@ } } }, - "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:troubleshoot": { + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repair": { "post": { "tags": [ "Dev Boxes" @@ -818,8 +818,8 @@ "$ref": "#/parameters/DevBoxNameParameter" } ], - "description": "Troubleshoot a Dev Box", - "operationId": "DevBoxes_TroubleshootDevBox", + "description": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", "x-ms-long-running-operation": true, "responses": { "202": { @@ -848,8 +848,57 @@ } }, "x-ms-examples": { - "DevBoxes_TroubleshootDevBox": { - "$ref": "./examples/DevBoxes_Troubleshoot.json" + "DevBoxes_RepairDevBox": { + "$ref": "./examples/DevBoxes_Repair.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repairResult": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Retrieves the result of the last repair operation on a Dev Box.", + "operationId": "DevBoxes_GetDevBoxRepairResult", + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "The request completed successfully.", + "schema": { + "$ref": "#/definitions/RepairResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetDevBoxRepairResult": { + "$ref": "./examples/DevBoxes_GetRepairResult.json" } } } @@ -1468,6 +1517,38 @@ "value" ] }, + "RepairResult": { + "type": "object", + "description": "The result of a repair operation on a Dev Box.", + "properties": { + "status": { + "description": "The status of the repair operation.", + "type": "string" + }, + "resultCode": { + "description": "The result code of the repair operation.", + "type": "string" + }, + "resultMessage": { + "description": "The result message of the repair operation.", + "type": "string" + }, + "startTime": { + "description": "The time the repair operation started.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the repair operation ended.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "The error that occurred during the repair operation.", + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + } + }, "DevBox": { "type": "object", "description": "A Dev Box", @@ -1567,11 +1648,6 @@ "localAdministrator": { "description": "Indicates whether the owner of the Dev Box is a local administrator.", "$ref": "#/definitions/LocalAdminStatus" - }, - "lastOperationId": { - "description": "The ID of the most recent operation performed on the Dev Box.", - "readOnly": true, - "type": "string" } }, "required": [ diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index 4fe209894326..f0485b45c49f 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -310,13 +310,13 @@ } } }, - "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults": { "get": { "tags": [ - "Operations", + "ActionResults", "Environments" ], - "description": "Lists the operations for an environment.", + "description": "Lists the action results for an environment.", "parameters": [ { "$ref": "devcenter.json#/parameters/ApiVersionParameter" @@ -334,12 +334,12 @@ "$ref": "#/parameters/EnvironmentNameParameter" } ], - "operationId": "EnvironmentOperations_ListByEnvironment", + "operationId": "EnvironmentActionResults_ListByEnvironment", "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/EnvironmentOperationListResult" + "$ref": "#/definitions/ActionResultListResult" } }, "default": { @@ -356,8 +356,8 @@ } }, "x-ms-examples": { - "EnvironmentOperations_ListByEnvironment": { - "$ref": "./examples/EnvironmentOperations_ListByEnvironment.json" + "EnvironmentActionResults_ListByEnvironment": { + "$ref": "./examples/EnvironmentActionResults_ListByEnvironment.json" } }, "x-ms-pageable": { @@ -365,13 +365,13 @@ } } }, - "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationName}": { + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults/{actionResultName}": { "get": { "tags": [ - "Operations", + "ActionResults", "Environments" ], - "description": "Gets an environment operation.", + "description": "Gets an environment action result.", "parameters": [ { "$ref": "devcenter.json#/parameters/ApiVersionParameter" @@ -386,15 +386,15 @@ "$ref": "#/parameters/EnvironmentNameParameter" }, { - "$ref": "#/parameters/EnvironmentOperationNameParameter" + "$ref": "#/parameters/ActionResultNameParameter" } ], - "operationId": "EnvironmentOperations_GetByEnvironment", + "operationId": "EnvironmentActionResults_GetByEnvironment", "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/EnvironmentOperation" + "$ref": "#/definitions/ActionResult" } }, "default": { @@ -411,19 +411,19 @@ } }, "x-ms-examples": { - "EnvironmentOperations_GetByEnvironment": { - "$ref": "./examples/EnvironmentOperations_GetByEnvironment.json" + "EnvironmentActionResults_GetByEnvironment": { + "$ref": "./examples/EnvironmentActionResults_GetByEnvironment.json" } } } }, - "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationName}/logs": { + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults/{actionResultName}/logs": { "get": { "tags": [ - "Operations", + "ActionResults", "Environments" ], - "description": "Gets an environment operations logs.", + "description": "Gets the logs for an action on an environment.", "produces": [ "text/plain" ], @@ -441,10 +441,10 @@ "$ref": "#/parameters/EnvironmentNameParameter" }, { - "$ref": "#/parameters/EnvironmentOperationNameParameter" + "$ref": "#/parameters/ActionResultNameParameter" } ], - "operationId": "EnvironmentOperations_GetLogs", + "operationId": "EnvironmentActionResults_GetLogs", "responses": { "200": { "description": "OK. The request has succeeded.", @@ -455,8 +455,8 @@ } }, "x-ms-examples": { - "EnvironmentOperations_GetLogs": { - "$ref": "./examples/EnvironmentOperations_GetLogs.json" + "EnvironmentActionResults_GetLogs": { + "$ref": "./examples/EnvironmentActionResults_GetLogs.json" } } } @@ -1111,15 +1111,15 @@ ] } }, - "EnvironmentOperationListResult": { + "ActionResultListResult": { "type": "object", - "description": "The operations list result.", + "description": "The action results list result.", "properties": { "value": { "description": "The current page of results.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentOperation" + "$ref": "#/definitions/ActionResult" } }, "nextLink": { @@ -1131,48 +1131,48 @@ "value" ] }, - "EnvironmentOperation": { + "ActionResult": { "type": "object", - "description": "An operation on an environment.", + "description": "The result of an action on an environment.", "properties": { "id": { - "description": "Unique identifier for the environment operation.", + "description": "Unique identifier for the environment action.", "type": "string", "readOnly": true }, "name": { - "description": "The name of the operation.", + "description": "The name of the action.", "type": "string", "readOnly": true }, - "type": { - "description": "The type of operation that was taken.", + "kind": { + "description": "The kind of action that was taken.", "type": "string", "readOnly": true }, "status": { - "description": "The operation status.", + "description": "The action status.", "type": "string", "readOnly": true }, "parameters": { "type": "object", - "description": "Parameters object for the operation.", + "description": "Parameters object for the action.", "readOnly": true }, "createdByObjectId": { - "description": "The object ID of the actor which initiated the operation'.", + "description": "The object ID of the actor which initiated the action'.", "type": "string", "readOnly": true }, "startTime": { - "description": "The time the operation started.", + "description": "The time the action started.", "type": "string", "readOnly": true, "format": "date-time" }, "endTime": { - "description": "The time the operation finished.", + "description": "The time the action finished.", "type": "string", "readOnly": true, "format": "date-time" @@ -1219,15 +1219,15 @@ "description": "The name of the environment definition", "x-ms-parameter-location": "method" }, - "EnvironmentOperationNameParameter": { - "name": "operationName", + "ActionResultNameParameter": { + "name": "actionResultName", "in": "path", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", "minLength": 3, "maxLength": 63, - "description": "The name of the operation.", + "description": "The name of the action to check the result for.", "x-ms-parameter-location": "method" } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json index ed9b88956826..966fa35a9ded 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json @@ -31,8 +31,7 @@ "name": "DevImage", "version": "1.0.0", "publishedDate": "2022-03-01T00:13:23.323Z" - }, - "lastOperationId": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } } } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json new file mode 100644 index 000000000000..42b8f587721d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "resultCode": "ErrorUrlsNotAccessible", + "resultMessage": "You can't connect to this Dev Box because it can't access required URLs. Contact your administrator to unblock the URLs that your Dev Box uses to connect.", + "startTime": "2023-02-01T12:43:54.122Z", + "endTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json index c4c3c86929c3..296df830da96 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json @@ -30,8 +30,7 @@ "name": "DevImage", "version": "1.0.0", "publishedDate": "2022-03-01T00:13:23.323Z" - }, - "lastOperationId": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } } ] } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json index ec89f8262544..3eae4d6a29fd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json @@ -32,8 +32,7 @@ "name": "DevImage", "version": "1.0.0", "publishedDate": "2022-03-01T00:13:23.323Z" - }, - "lastOperationId": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } } ] } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Troubleshoot.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Repair.json similarity index 100% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Troubleshoot.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Repair.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json similarity index 83% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json index 75f69cc70664..cce8b3899b5c 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json @@ -5,15 +5,15 @@ "projectName": "myProject", "userId": "me", "environmentName": "myEnvironment", - "operationName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + "actionResultName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" }, "responses": { "200": { "body": { - "id": "/projects/myProject/users/me/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "id": "/projects/myProject/users/me/environments/myEnvironment/actionResults/f5dbdfab-fa0e-4831-8d13-25359aa5e680", "name": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", "status": "Failed", - "type": "Deploy", + "kind": "Deploy", "parameters": { "paramA": "valueA", "paramB": "valueB" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json similarity index 85% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json index e65107362320..cacc01844403 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json @@ -5,7 +5,7 @@ "projectName": "myProject", "userId": "me", "environmentName": "myEnvironment", - "operationName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + "actionResultName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" }, "responses": { "200": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json similarity index 90% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json index ac83e7c4a10a..a679ec47e526 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json @@ -11,10 +11,10 @@ "body": { "value": [ { - "id": "/projects/myProject/users/me/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "id": "/projects/myProject/users/me/environments/myEnvironment/actionResults/f5dbdfab-fa0e-4831-8d13-25359aa5e680", "name": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", "status": "Failed", - "type": "Deploy", + "kind": "Deploy", "parameters": { "paramA": "valueA", "paramB": "valueB" From b10c41a313d236e4cafd84668496b385b6e6e687 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 10:34:02 -0400 Subject: [PATCH 13/23] Update with aligned operations API, URI property, file type log response --- .../preview/2023-07-01-preview/devbox.json | 389 +++++++++++++++--- .../preview/2023-07-01-preview/devcenter.json | 6 +- .../2023-07-01-preview/environments.json | 149 ++++--- .../examples/Catalogs_Get.json | 2 +- .../examples/Catalogs_ListByProject.json | 2 +- .../examples/DevBoxActions_Delay.json | 2 +- .../examples/DevBoxActions_DelayMultiple.json | 6 +- .../DevBoxActions_DelayMultipleWithError.json | 5 +- .../examples/DevBoxActions_Get.json | 2 +- .../examples/DevBoxActions_List.json | 4 +- .../examples/DevBoxOperations_Get.json | 23 ++ .../examples/DevBoxOperations_List.json | 40 ++ .../examples/DevBoxes_Create.json | 4 +- .../examples/DevBoxes_Get.json | 2 +- .../examples/DevBoxes_List.json | 2 +- .../DevBoxes_ListByUserByProject.json | 2 +- .../examples/EnvironmentDefinitions_Get.json | 1 + .../EnvironmentDefinitions_ListByCatalog.json | 2 + .../EnvironmentDefinitions_ListByProject.json | 2 + ...nvironmentOperations_GetByEnvironment.json | 27 ++ .../EnvironmentOperations_GetLogs.json | 15 + ...vironmentOperations_ListByEnvironment.json | 30 ++ .../EnvironmentTypes_ListByProject.json | 2 +- ...onments_CreateByEnvironmentDefinition.json | 2 +- .../examples/Environments_Get.json | 2 +- .../examples/Environments_ListByProject.json | 2 +- .../Environments_ListByProjectByUser.json | 2 +- .../examples/Pools_Get.json | 2 +- .../examples/Pools_List.json | 4 +- .../examples/Projects_Get.json | 2 +- .../examples/Projects_ListByDevCenter.json | 2 +- .../examples/Schedules_Get.json | 2 +- .../examples/Schedules_List.json | 2 +- .../examples/Schedules_ListByProject.json | 2 +- 34 files changed, 584 insertions(+), 159 deletions(-) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index a1dcd4dcc1c9..849e2b249f2d 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -854,55 +854,6 @@ } } }, - "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repairResult": { - "get": { - "tags": [ - "Dev Boxes" - ], - "parameters": [ - { - "$ref": "devcenter.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "devcenter.json#/parameters/ProjectNameParameter" - }, - { - "$ref": "devcenter.json#/parameters/UserIdParameter" - }, - { - "$ref": "#/parameters/DevBoxNameParameter" - } - ], - "description": "Retrieves the result of the last repair operation on a Dev Box.", - "operationId": "DevBoxes_GetDevBoxRepairResult", - "x-ms-long-running-operation": true, - "responses": { - "200": { - "description": "The request completed successfully.", - "schema": { - "$ref": "#/definitions/RepairResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "devcenter.json#/definitions/CloudError" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "DevBoxes_GetDevBoxRepairResult": { - "$ref": "./examples/DevBoxes_GetRepairResult.json" - } - } - } - }, "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { "get": { "tags": [ @@ -1213,6 +1164,115 @@ }, "x-ms-odata": "#/definitions/DevBoxActionDelayResult" } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations": { + "get": { + "tags": [ + "DevBoxOperations" + ], + "description": "Lists operations on the Dev Box which have occurred within the past 30 days.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "operationId": "DevBoxOperations_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxOperations_List": { + "$ref": "./examples/DevBoxOperations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBoxOperation" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}": { + "get": { + "tags": [ + "DevBoxOperations" + ], + "description": "Gets an operation on a Dev Box.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxOperationIdParameter" + } + ], + "operationId": "DevBoxOperations_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxOperations_Get": { + "$ref": "./examples/DevBoxOperations_Get.json" + } + } + } } }, "definitions": { @@ -1240,8 +1300,8 @@ "type": "object", "description": "A pool of Dev Boxes.", "properties": { - "id": { - "description": "The ID of the pool", + "uri": { + "description": "The unique URI of the pool", "type": "string" }, "name": { @@ -1286,7 +1346,7 @@ } }, "required": [ - "id", + "uri", "name", "location", "healthStatus" @@ -1424,8 +1484,8 @@ "type": "object", "description": "A Schedule to execute action.", "properties": { - "id": { - "description": "The ID of the schedule", + "uri": { + "description": "The unique URI of the schedule", "type": "string" }, "name": { @@ -1454,7 +1514,7 @@ } }, "required": [ - "id", + "uri", "name", "sourceId", "type", @@ -1553,8 +1613,8 @@ "type": "object", "description": "A Dev Box", "properties": { - "id": { - "description": "The ID of the dev box", + "uri": { + "description": "The unique URI of the dev box", "type": "string", "readOnly": true }, @@ -1840,10 +1900,9 @@ "type": "object", "description": "The action delay result", "properties": { - "id": { - "description": "Unique identifier for the dev box action within a dev center", + "uri": { "type": "string", - "readOnly": true + "description": "The unique URI of the action." }, "name": { "type": "string", @@ -1866,6 +1925,7 @@ }, "required": [ "name", + "uri", "result" ] }, @@ -1915,10 +1975,9 @@ "type": "object", "description": "An action which will take place on a Dev Box.", "properties": { - "id": { - "description": "Unique identifier for the dev box action within a dev center", - "type": "string", - "readOnly": true + "uri": { + "description": "The unique URI for the Dev Box action.", + "type": "string" }, "name": { "description": "The name of the action.", @@ -1944,6 +2003,7 @@ }, "required": [ "name", + "uri", "actionType", "sourceId" ] @@ -1978,6 +2038,196 @@ "required": [ "scheduledTime" ] + }, + "DevBoxOperationListResult": { + "type": "object", + "description": "The result of listing operations on a Dev Box.", + "properties": { + "value": { + "description": "The current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBoxOperation": { + "type": "object", + "description": "Information about an operation on a Dev Box.", + "discriminator": "kind", + "properties": { + "uri": { + "description": "The unique URI for the Dev Box operation.", + "type": "string" + }, + "operationId": { + "description": "Unique identifier for the Dev Box operation.", + "type": "string" + }, + "kind": { + "description": "The kind of operation that occurred.", + "$ref": "#/definitions/DevBoxOperationKind" + }, + "status": { + "description": "The operation status.", + "type": "string" + }, + "createdByObjectId": { + "description": "The object ID of the actor which initiated the operation.", + "type": "string" + }, + "startTime": { + "description": "The time the operation started.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "Provisioning or operation error details. Populated only for error states.", + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "DevBoxStartOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "x-ms-discriminator-value": "Start", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ] + }, + "DevBoxStopOperation": { + "type": "object", + "description": "Information about a stop operation on a Dev Box.", + "x-ms-discriminator-value": "Stop", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ] + }, + "DevBoxRestartOperation": { + "type": "object", + "description": "Information about a restart operation on a Dev Box.", + "x-ms-discriminator-value": "Restart", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ] + }, + "DevBoxRepairOperation": { + "type": "object", + "description": "Information about a repair operation on a Dev Box.", + "x-ms-discriminator-value": "Repair", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "properties": { + "result": { + "description": "The result of the repair operation.", + "$ref": "#/definitions/DevBoxRepairOperationResult" + } + } + }, + "DevBoxRepairOperationResult": { + "description": "Information about the result of a repair operation on a Dev Box.", + "type": "object", + "properties": { + "repairOutcome": { + "description": "The outcome of the repair operation.", + "$ref": "#/definitions/DevBoxRepairOutcome" + }, + "code": { + "description": "The result code associated with the repair operation.", + "type": "string" + }, + "message": { + "description": "The result message associated with the repair operation.", + "type": "string" + } + } + }, + "DevBoxRepairOutcome": { + "type": "string", + "enum": [ + "FixApplied", + "IssuesDetected", + "NoIssuesDetected" + ], + "description": "The action taken during a repair operation.", + "x-ms-enum": { + "name": "DevBoxRepairOutcome", + "modelAsString": true, + "values": [ + { + "value": "FixApplied", + "description": "A fix for an issue was automatically applied to the Dev Box." + }, + { + "value": "IssuesDetected", + "description": "One or more issues was detected on the Dev Box, but they could not be fixed automatically." + }, + { + "value": "NoIssuesDetected", + "description": "The service did not identify any issues on the Dev Box." + } + ] + } + }, + "DevBoxOperationKind": { + "type": "string", + "enum": [ + "Start", + "Stop", + "Restart", + "Repair" + ], + "description": "The type of Dev Box operation.", + "x-ms-enum": { + "name": "DevBoxOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "The operation represents a Dev Box start." + }, + { + "value": "Stop", + "description": "The operation represents a Dev Box stop." + }, + { + "value": "Restart", + "description": "The operation represents a Dev Box restart." + }, + { + "value": "Repair", + "description": "The operation represents a Dev Box repair." + } + ] + } } }, "parameters": { @@ -2038,6 +2288,17 @@ "format": "date-time", "in": "query", "x-ms-parameter-location": "method" + }, + "DevBoxOperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The id of the operation on a Dev Box.", + "x-ms-parameter-location": "method" } } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json index da80a10c7cf4..6e4deb61719b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json @@ -145,8 +145,8 @@ "description": "Project details.", "type": "object", "properties": { - "id": { - "description": "The ID of the project", + "uri": { + "description": "The unique URI of the project", "type": "string" }, "name": { @@ -165,7 +165,7 @@ } }, "required": [ - "id", + "uri", "name" ] }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index f0485b45c49f..aed1e392b2c0 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -310,13 +310,13 @@ } } }, - "/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults": { + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { "get": { "tags": [ - "ActionResults", + "EnvironmentOperations", "Environments" ], - "description": "Lists the action results for an environment.", + "description": "Lists operations on the environment which have occurred within the past 30 days", "parameters": [ { "$ref": "devcenter.json#/parameters/ApiVersionParameter" @@ -324,6 +324,9 @@ { "$ref": "devcenter.json#/parameters/TopParameter" }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, { "$ref": "devcenter.json#/parameters/ProjectNameParameter" }, @@ -334,12 +337,12 @@ "$ref": "#/parameters/EnvironmentNameParameter" } ], - "operationId": "EnvironmentActionResults_ListByEnvironment", + "operationId": "EnvironmentOperations_ListByEnvironment", "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/ActionResultListResult" + "$ref": "#/definitions/EnvironmentOperationListResult" } }, "default": { @@ -356,8 +359,8 @@ } }, "x-ms-examples": { - "EnvironmentActionResults_ListByEnvironment": { - "$ref": "./examples/EnvironmentActionResults_ListByEnvironment.json" + "EnvironmentOperations_ListByEnvironment": { + "$ref": "./examples/EnvironmentOperations_ListByEnvironment.json" } }, "x-ms-pageable": { @@ -365,10 +368,10 @@ } } }, - "/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults/{actionResultName}": { + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}": { "get": { "tags": [ - "ActionResults", + "EnvironmentOperations", "Environments" ], "description": "Gets an environment action result.", @@ -386,15 +389,15 @@ "$ref": "#/parameters/EnvironmentNameParameter" }, { - "$ref": "#/parameters/ActionResultNameParameter" + "$ref": "#/parameters/EnvironmentOperationIdParameter" } ], - "operationId": "EnvironmentActionResults_GetByEnvironment", + "operationId": "EnvironmentOperations_GetByEnvironment", "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/ActionResult" + "$ref": "#/definitions/EnvironmentOperation" } }, "default": { @@ -411,19 +414,19 @@ } }, "x-ms-examples": { - "EnvironmentActionResults_GetByEnvironment": { - "$ref": "./examples/EnvironmentActionResults_GetByEnvironment.json" + "EnvironmentOperations_GetByEnvironment": { + "$ref": "./examples/EnvironmentOperations_GetByEnvironment.json" } } } }, - "/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults/{actionResultName}/logs": { + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs": { "get": { "tags": [ - "ActionResults", + "EnvironmentOperations", "Environments" ], - "description": "Gets the logs for an action on an environment.", + "description": "Gets the logs for an operation on an environment.", "produces": [ "text/plain" ], @@ -441,22 +444,21 @@ "$ref": "#/parameters/EnvironmentNameParameter" }, { - "$ref": "#/parameters/ActionResultNameParameter" + "$ref": "#/parameters/EnvironmentOperationIdParameter" } ], - "operationId": "EnvironmentActionResults_GetLogs", + "operationId": "EnvironmentOperations_GetLogs", "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "type": "string", - "format": "byte" + "type": "file" } } }, "x-ms-examples": { - "EnvironmentActionResults_GetLogs": { - "$ref": "./examples/EnvironmentActionResults_GetLogs.json" + "EnvironmentOperations_GetLogs": { + "$ref": "./examples/EnvironmentOperations_GetLogs.json" } } } @@ -770,8 +772,8 @@ } ], "properties": { - "id": { - "description": "The ID of the environment", + "uri": { + "description": "The unique URI of the environment", "type": "string", "readOnly": true }, @@ -875,8 +877,8 @@ "description": "A catalog.", "type": "object", "properties": { - "id": { - "description": "The ID of the catalog", + "uri": { + "description": "The unique URI of the catalog", "type": "string" }, "name": { @@ -885,7 +887,7 @@ } }, "required": [ - "id", + "uri", "name" ] }, @@ -913,6 +915,10 @@ "description": "An environment definition.", "type": "object", "properties": { + "uri": { + "description": "The unique URI of the environment definition", + "type": "string" + }, "id": { "description": "The ID of the environment definition.", "type": "string" @@ -947,6 +953,7 @@ }, "required": [ "name", + "uri", "catalogName", "id" ] @@ -1023,8 +1030,8 @@ "description": "Properties of an environment type.", "type": "object", "properties": { - "id": { - "description": "The ID of the environment type", + "uri": { + "description": "The unique URI of the environment type", "type": "string" }, "name": { @@ -1032,7 +1039,7 @@ "type": "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.", + "description": "The 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.", "type": "string" }, "status": { @@ -1041,7 +1048,7 @@ } }, "required": [ - "id", + "uri", "name", "deploymentTargetId", "status" @@ -1111,7 +1118,7 @@ ] } }, - "ActionResultListResult": { + "EnvironmentOperationListResult": { "type": "object", "description": "The action results list result.", "properties": { @@ -1119,7 +1126,7 @@ "description": "The current page of results.", "type": "array", "items": { - "$ref": "#/definitions/ActionResult" + "$ref": "#/definitions/EnvironmentOperation" } }, "nextLink": { @@ -1131,57 +1138,71 @@ "value" ] }, - "ActionResult": { + "EnvironmentOperation": { "type": "object", - "description": "The result of an action on an environment.", + "description": "Information about an operation on an environment.", "properties": { - "id": { - "description": "Unique identifier for the environment action.", - "type": "string", - "readOnly": true + "uri": { + "description": "The unique URI for the environment operation.", + "type": "string" }, - "name": { - "description": "The name of the action.", - "type": "string", - "readOnly": true + "operationId": { + "description": "Unique identifier for the environment operation.", + "type": "string" }, "kind": { - "description": "The kind of action that was taken.", - "type": "string", - "readOnly": true + "description": "The kind of operation that occurred.", + "$ref": "#/definitions/EnvironmentOperationKind" }, "status": { - "description": "The action status.", - "type": "string", - "readOnly": true + "description": "The operation status.", + "type": "string" }, "parameters": { "type": "object", - "description": "Parameters object for the action.", - "readOnly": true + "description": "Parameters object for the operation." }, "createdByObjectId": { - "description": "The object ID of the actor which initiated the action'.", - "type": "string", - "readOnly": true + "description": "The object ID of the actor which initiated the operation.", + "type": "string" }, "startTime": { - "description": "The time the action started.", + "description": "The time the operation started.", "type": "string", - "readOnly": true, "format": "date-time" }, "endTime": { - "description": "The time the action finished.", + "description": "The time the operation finished.", "type": "string", - "readOnly": true, "format": "date-time" }, "error": { - "description": "Provisioning or action error details. Populated only for error states.", - "readOnly": true, + "description": "Provisioning or operation error details. Populated only for error states.", "$ref": "devcenter.json#/definitions/CloudErrorBody" } + }, + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "EnvironmentOperationKind": { + "type": "string", + "enum": [ + "Deployment" + ], + "description": "The type of environment operation.", + "x-ms-enum": { + "name": "EnvironmentOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Deployment", + "description": "The operation represents a deployment." + } + ] } } }, @@ -1219,15 +1240,15 @@ "description": "The name of the environment definition", "x-ms-parameter-location": "method" }, - "ActionResultNameParameter": { - "name": "actionResultName", + "EnvironmentOperationIdParameter": { + "name": "operationId", "in": "path", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", "minLength": 3, "maxLength": 63, - "description": "The name of the action to check the result for.", + "description": "The id of the operation on an environment.", "x-ms-parameter-location": "method" } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json index f1e47b9d3e1b..9907e439268b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json @@ -8,7 +8,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/catalogs/foo", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", "name": "foo" } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json index bb1fe429e03b..bf16db392fac 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "id": "/projects/myProject/catalogs/foo", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", "name": "foo" } ] diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json index 7e4598babd7e..ff59d98f64fc 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json @@ -11,7 +11,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json index c9f682d800d1..008ad9d5c6c3 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json @@ -12,10 +12,11 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "result": "Succeeded", "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", @@ -26,10 +27,11 @@ } }, { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/idle-hibernateondisconnect", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "result": "Succeeded", "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json index fe7b55509e1f..a5e24a2c6755 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json @@ -12,7 +12,7 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "result": "Failed", "error": { @@ -21,10 +21,11 @@ } }, { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/idle-hibernateondisconnect", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "result": "Succeeded", "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json index 9dc5f4cd1d9d..c8d26c7245f4 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json @@ -10,7 +10,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json index 0597dbbec62f..e10519d43168 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json @@ -11,7 +11,7 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/idle-hibernateondisconnect", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", @@ -20,7 +20,7 @@ } }, { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_Get.json new file mode 100644 index 000000000000..d72ec9dbdb33 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json new file mode 100644 index 000000000000..d342b13a9e7b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairAction": "FixApplied" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json index c5b17ea7e487..82c5125b492c 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Create.json @@ -12,7 +12,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "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", @@ -43,7 +43,7 @@ "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/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "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", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json index 966fa35a9ded..1548ef986abf 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_Get.json @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "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", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json index 296df830da96..04ed7f1e7c51 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_List.json @@ -8,7 +8,7 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "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", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json index 3eae4d6a29fd..cdff995f8fcf 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_ListByUserByProject.json @@ -10,7 +10,7 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "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", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json index 59d8e902edfa..7fcbd5fb2b91 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_Get.json @@ -9,6 +9,7 @@ "responses": { "200": { "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", "name": "foo", "catalogName": "myCatalog", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json index 6041cfd8ec5f..b4422da6a26e 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json @@ -10,6 +10,7 @@ "body": { "value": [ { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", "name": "foo", "catalogName": "myCatalog", @@ -52,6 +53,7 @@ "templatePath": "azuredeploy.json" }, { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", "name": "bar", "catalogName": "myCatalog", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json index 4f42e9cc5d53..7a9bcfbf2dc1 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentDefinitions_ListByProject.json @@ -9,6 +9,7 @@ "body": { "value": [ { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", "name": "foo", "catalogName": "myCatalog", @@ -51,6 +52,7 @@ "templatePath": "azuredeploy.json" }, { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", "name": "bar", "catalogName": "myOtherCatalog", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json new file mode 100644 index 000000000000..ef37655ec609 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deployment", + "parameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json new file mode 100644 index 000000000000..c400403cb27a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetLogs.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json new file mode 100644 index 000000000000..a6ea8fb39322 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deployment", + "parameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json index 078b7f8d4d3e..8a93790d10da 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentTypes_ListByProject.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "id": "/projects/myProject/environmentTypes/devtestenv", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", "name": "devtestenv", "status": "Enabled", "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json index 16ff8a19682b..a0c80160d966 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_CreateByEnvironmentDefinition.json @@ -22,7 +22,7 @@ "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/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json index 9d9f95f03948..26e94e8d71be 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_Get.json @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json index 7501f84fef35..2646c9964fb2 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProject.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json index d1502e450b04..d3a6eaed41a7 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Environments_ListByProjectByUser.json @@ -10,7 +10,7 @@ "body": { "value": [ { - "id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/mydevenv", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", "name": "mydevenv", "environmentType": "DevTest", "catalogName": "main", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json index 917d816911ab..770c9e59dfda 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_Get.json @@ -8,7 +8,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/pools/LargeDevWorkStationPool", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", "name": "LargeDevWorkStationPool", "location": "centralus", "osType": "Windows", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json index 0516fddf6da3..05fb954162d7 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Pools_List.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "id": "/projects/myProject/pools/LargeDevWorkStationPool", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", "name": "LargeDevWorkStationPool", "location": "centralus", "osType": "Windows", @@ -35,7 +35,7 @@ "healthStatus": "Healthy" }, { - "id": "/projects/myProject/pools/SQLDevelopmentMachinePool", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", "name": "SQLDevelopmentMachinePool", "location": "southcentralus", "osType": "Windows", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json index 5d0e545c9e80..22814bd945a9 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_Get.json @@ -7,7 +7,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", "name": "DevDiv", "description": "The developer division" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json index 78609c5713a8..7458c63d6a06 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Projects_ListByDevCenter.json @@ -8,7 +8,7 @@ "body": { "value": [ { - "id": "/projects/myProject", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", "name": "DevDiv", "description": "The developer division" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json index 3d76098114da..7dba9c6b425c 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "/projects/myProject/pools/DevPool/schedules/default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", "sourceId": "/projects/myProject/pools/DevPool", "type": "StopDevBox", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json index 38252e4d2a3a..54312a076ebe 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json @@ -10,7 +10,7 @@ "body": { "value": [ { - "id": "/projects/myProject/pools/DevPool/schedules/default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", "sourceId": "/projects/myProject/pools/DevPool", "type": "StopDevBox", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json index 0e257cd4f1b4..346665622fb7 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "id": "/projects/myProject/pools/DevPool/schedules/default", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", "sourceId": "/projects/myProject/pools/DevPool", "type": "StopDevBox", From e001f36445a0c1710a5617a274d87919c0cea302 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 10:39:55 -0400 Subject: [PATCH 14/23] Remove old examples --- .../examples/DevBoxes_GetRepairResult.json | 20 ------------- ...ronmentActionResults_GetByEnvironment.json | 27 ----------------- .../EnvironmentActionResults_GetLogs.json | 15 ---------- ...onmentActionResults_ListByEnvironment.json | 30 ------------------- 4 files changed, 92 deletions(-) delete mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json delete mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json delete mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json delete mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json deleted file mode 100644 index 42b8f587721d..000000000000 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxes_GetRepairResult.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "api-version": "2023-07-01-preview", - "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", - "projectName": "myProject", - "userId": "me", - "devBoxName": "MyDevBox" - }, - "responses": { - "200": { - "body": { - "status": "Succeeded", - "resultCode": "ErrorUrlsNotAccessible", - "resultMessage": "You can't connect to this Dev Box because it can't access required URLs. Contact your administrator to unblock the URLs that your Dev Box uses to connect.", - "startTime": "2023-02-01T12:43:54.122Z", - "endTime": "2023-02-01T12:43:54.122Z" - } - } - } -} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json deleted file mode 100644 index cce8b3899b5c..000000000000 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetByEnvironment.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2023-07-01-preview", - "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", - "projectName": "myProject", - "userId": "me", - "environmentName": "myEnvironment", - "actionResultName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" - }, - "responses": { - "200": { - "body": { - "id": "/projects/myProject/users/me/environments/myEnvironment/actionResults/f5dbdfab-fa0e-4831-8d13-25359aa5e680", - "name": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", - "status": "Failed", - "kind": "Deploy", - "parameters": { - "paramA": "valueA", - "paramB": "valueB" - }, - "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", - "startTime": "2022-09-06T16:58:51.7229492+00:00", - "endTime": "2022-09-06T16:59:51.7229492+00:00" - } - } - } -} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json deleted file mode 100644 index cacc01844403..000000000000 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_GetLogs.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "api-version": "2023-07-01-preview", - "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", - "projectName": "myProject", - "userId": "me", - "environmentName": "myEnvironment", - "actionResultName": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" - }, - "responses": { - "200": { - "body": "This is an example log output." - } - } -} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json deleted file mode 100644 index a679ec47e526..000000000000 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentActionResults_ListByEnvironment.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2023-07-01-preview", - "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", - "projectName": "myProject", - "userId": "me", - "environmentName": "myEnvironment" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/projects/myProject/users/me/environments/myEnvironment/actionResults/f5dbdfab-fa0e-4831-8d13-25359aa5e680", - "name": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", - "status": "Failed", - "kind": "Deploy", - "parameters": { - "paramA": "valueA", - "paramB": "valueB" - }, - "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", - "startTime": "2022-09-06T16:58:51.7229492+00:00", - "endTime": "2022-09-06T16:59:51.7229492+00:00" - } - ] - } - } - } -} From c41019c9f2e0137c89913e38e635312954c33ad7 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 12:18:30 -0400 Subject: [PATCH 15/23] Fix naming --- .../2023-07-01-preview/examples/DevBoxOperations_List.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json index d342b13a9e7b..616086717833 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxOperations_List.json @@ -30,11 +30,11 @@ "result": { "code": "ConnectivityFixApplied", "message": "We resolved some connectivity issues with your Dev Box.", - "repairAction": "FixApplied" + "repairOutcome": "FixApplied" } } ] } } } -} \ No newline at end of file +} From eb9ee7ece3c3e7b8369ec2e2b48386075e61f364 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 15:57:11 -0400 Subject: [PATCH 16/23] Update TTL to 90 days on operations, add delete operationkind --- .../preview/2023-07-01-preview/devbox.json | 2 +- .../2023-07-01-preview/environments.json | 40 +++++++++++++++---- ...nvironmentOperations_GetByEnvironment.json | 4 +- ...vironmentOperations_ListByEnvironment.json | 4 +- 4 files changed, 38 insertions(+), 12 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 849e2b249f2d..7c9572a65925 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1170,7 +1170,7 @@ "tags": [ "DevBoxOperations" ], - "description": "Lists operations on the Dev Box which have occurred within the past 30 days.", + "description": "Lists operations on the Dev Box which have occurred within the past 90 days.", "parameters": [ { "$ref": "devcenter.json#/parameters/ApiVersionParameter" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index aed1e392b2c0..4b4d58391f1b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -316,7 +316,7 @@ "EnvironmentOperations", "Environments" ], - "description": "Lists operations on the environment which have occurred within the past 30 days", + "description": "Lists operations on the environment which have occurred within the past 90 days", "parameters": [ { "$ref": "devcenter.json#/parameters/ApiVersionParameter" @@ -1141,6 +1141,7 @@ "EnvironmentOperation": { "type": "object", "description": "Information about an operation on an environment.", + "discriminator": "kind", "properties": { "uri": { "description": "The unique URI for the environment operation.", @@ -1158,10 +1159,6 @@ "description": "The operation status.", "type": "string" }, - "parameters": { - "type": "object", - "description": "Parameters object for the operation." - }, "createdByObjectId": { "description": "The object ID of the actor which initiated the operation.", "type": "string" @@ -1176,6 +1173,10 @@ "type": "string", "format": "date-time" }, + "environmentParameters": { + "type": "object", + "description": "Parameters object for the environment at the time of the operation." + }, "error": { "description": "Provisioning or operation error details. Populated only for error states.", "$ref": "devcenter.json#/definitions/CloudErrorBody" @@ -1191,7 +1192,8 @@ "EnvironmentOperationKind": { "type": "string", "enum": [ - "Deployment" + "Deploy", + "Delete" ], "description": "The type of environment operation.", "x-ms-enum": { @@ -1199,11 +1201,35 @@ "modelAsString": true, "values": [ { - "value": "Deployment", + "value": "Deploy", "description": "The operation represents a deployment." + }, + { + "value": "Delete", + "description": "The operation represents a delete." } ] } + }, + "EnvironmentDeployOperation": { + "type": "object", + "description": "Information about a deploy operation on an environment.", + "x-ms-discriminator-value": "Deploy", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ] + }, + "EnvironmentDeleteOperation": { + "type": "object", + "description": "Information about a delete operation on an environment.", + "x-ms-discriminator-value": "Delete", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ] } }, "parameters": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json index ef37655ec609..9983dacd06aa 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_GetByEnvironment.json @@ -13,8 +13,8 @@ "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", "status": "Succeeded", - "kind": "Deployment", - "parameters": { + "kind": "Deploy", + "environmentParameters": { "paramA": "valueA", "paramB": "valueB" }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json index a6ea8fb39322..227f4dca7352 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/EnvironmentOperations_ListByEnvironment.json @@ -14,8 +14,8 @@ "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", "status": "Succeeded", - "kind": "Deployment", - "parameters": { + "kind": "Deploy", + "environmentParameters": { "paramA": "valueA", "paramB": "valueB" }, From d5aca43f6e0d8258dc80a8a7dd8bc4912d434a07 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 17:46:17 -0400 Subject: [PATCH 17/23] Add sourceType --- .../preview/2023-07-01-preview/devbox.json | 51 ++++++++++++++++++- .../examples/DevBoxActions_Delay.json | 1 + .../examples/DevBoxActions_DelayMultiple.json | 2 + .../DevBoxActions_DelayMultipleWithError.json | 1 + .../examples/DevBoxActions_Get.json | 1 + .../examples/DevBoxActions_List.json | 2 + .../examples/Schedules_Get.json | 1 + .../examples/Schedules_List.json | 1 + .../examples/Schedules_ListByProject.json | 1 + 9 files changed, 60 insertions(+), 1 deletion(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 7c9572a65925..89a672ef1038 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1496,6 +1496,10 @@ "description": "The id of the resource that this schedule belongs to", "type": "string" }, + "sourceType": { + "description": "The type of the resource that this schedule belongs to", + "$ref": "#/definitions/ScheduleSourceType" + }, "type": { "description": "Supported type this scheduled task represents.", "$ref": "#/definitions/ScheduledType" @@ -1517,6 +1521,7 @@ "uri", "name", "sourceId", + "sourceType", "type", "frequency", "time", @@ -1991,6 +1996,10 @@ "description": "The id of the resource which triggered this action", "type": "string" }, + "sourceType": { + "description": "The type of the resource which triggered this action", + "$ref": "#/definitions/DevBoxActionSourceType" + }, "suspendedUntil": { "description": "The earliest time that the action could occur (UTC).", "type": "string", @@ -2005,7 +2014,8 @@ "name", "uri", "actionType", - "sourceId" + "sourceId", + "sourceType" ] }, "DevBoxActionType": { @@ -2228,6 +2238,45 @@ } ] } + }, + "ScheduleSourceType": { + "type": "string", + "enum": [ + "Pool" + ], + "description": "The type of the resource that this schedule belongs to.", + "x-ms-enum": { + "name": "ScheduleSourceType", + "modelAsString": true, + "values": [ + { + "value": "Pool", + "description": "The schedule source is a Dev Box pool." + } + ] + } + }, + "DevBoxActionSourceType": { + "type": "string", + "enum": [ + "Pool", + "Schedule" + ], + "description": "The type of the resource which triggered the action.", + "x-ms-enum": { + "name": "DevBoxActionSourceType", + "modelAsString": true, + "values": [ + { + "value": "Pool", + "description": "The action was triggered by a Dev Box pool." + }, + { + "value": "Schedule", + "description": "The action was triggered by a Dev Box schedule." + } + ] + } } }, "parameters": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json index ff59d98f64fc..2dacb9d070ce 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json @@ -15,6 +15,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", "suspendedUntil": "2022-09-30T17:00:00Z", "next": { "scheduledTime": "2022-09-30T17:00:00Z" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json index 008ad9d5c6c3..e8cdc2dc3612 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json @@ -20,6 +20,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", "suspendedUntil": "2022-09-30T17:00:00Z", "next": { "scheduledTime": "2022-09-30T17:00:00Z" @@ -35,6 +36,7 @@ "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", + "sourceType": "Pool", "suspendedUntil": "2022-09-30T17:00:00Z" } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json index a5e24a2c6755..b40d178dbc63 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json @@ -29,6 +29,7 @@ "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", + "sourceType": "Pool", "suspendedUntil": "2022-09-30T17:00:00Z" } } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json index c8d26c7245f4..261ae16342f5 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json @@ -14,6 +14,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", "next": { "scheduledTime": "2022-09-30T17:00:00Z" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json index e10519d43168..9fbdb3c19949 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json @@ -15,6 +15,7 @@ "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", + "sourceType": "Pool", "next": { "scheduledTime": "2022-09-30T15:23:00Z" } @@ -24,6 +25,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", "suspendedUntil": "2022-09-30T17:00:00Z", "next": { "scheduledTime": "2022-09-30T17:00:00Z" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json index 7dba9c6b425c..4a321e6326c6 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json @@ -12,6 +12,7 @@ "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", "sourceId": "/projects/myProject/pools/DevPool", + "sourceType": "Pool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", "frequency": "Daily", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json index 54312a076ebe..5aab1c67b31c 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json @@ -13,6 +13,7 @@ "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", "sourceId": "/projects/myProject/pools/DevPool", + "sourceType": "Pool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", "frequency": "Daily", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json index 346665622fb7..3f880ebc4d66 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json @@ -12,6 +12,7 @@ "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", "sourceId": "/projects/myProject/pools/DevPool", + "sourceType": "Pool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", "frequency": "Daily", From 5820bdc58c7c8ae03fb729db190fb85785201c66 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 18:02:12 -0400 Subject: [PATCH 18/23] Remove old model --- .../preview/2023-07-01-preview/devbox.json | 32 ------------------- 1 file changed, 32 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 89a672ef1038..b9daa385582d 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1582,38 +1582,6 @@ "value" ] }, - "RepairResult": { - "type": "object", - "description": "The result of a repair operation on a Dev Box.", - "properties": { - "status": { - "description": "The status of the repair operation.", - "type": "string" - }, - "resultCode": { - "description": "The result code of the repair operation.", - "type": "string" - }, - "resultMessage": { - "description": "The result message of the repair operation.", - "type": "string" - }, - "startTime": { - "description": "The time the repair operation started.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the repair operation ended.", - "type": "string", - "format": "date-time" - }, - "error": { - "description": "The error that occurred during the repair operation.", - "$ref": "devcenter.json#/definitions/CloudErrorBody" - } - } - }, "DevBox": { "type": "object", "description": "A Dev Box", From 10c8727c62dfcd25d91c0beeea08e77752c1acdc Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Tue, 20 Jun 2023 18:11:55 -0400 Subject: [PATCH 19/23] Use an enum for status --- .../preview/2023-07-01-preview/devbox.json | 34 ++++++++++++++++++- .../2023-07-01-preview/environments.json | 34 ++++++++++++++++++- 2 files changed, 66 insertions(+), 2 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index b9daa385582d..d691b87a0558 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -2056,7 +2056,7 @@ }, "status": { "description": "The operation status.", - "type": "string" + "$ref": "#/definitions/DevBoxOperationStatus" }, "createdByObjectId": { "description": "The object ID of the actor which initiated the operation.", @@ -2207,6 +2207,38 @@ ] } }, + "DevBoxOperationStatus": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Running" + ], + "description": "The status of a Dev Box operation.", + "x-ms-enum": { + "name": "DevBoxOperationStatus", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "value": "Failed", + "description": "The operation failed." + }, + { + "value": "Canceled", + "description": "The operation was canceled." + }, + { + "value": "Running", + "description": "The operation is running." + } + ] + } + }, "ScheduleSourceType": { "type": "string", "enum": [ diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index 4b4d58391f1b..c5f42b3e3a8b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -1157,7 +1157,7 @@ }, "status": { "description": "The operation status.", - "type": "string" + "$ref": "#/definitions/EnvironmentOperationStatus" }, "createdByObjectId": { "description": "The object ID of the actor which initiated the operation.", @@ -1211,6 +1211,38 @@ ] } }, + "EnvironmentOperationStatus": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Running" + ], + "description": "The status of an environment operation.", + "x-ms-enum": { + "name": "EnvironmentOperationStatus", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "value": "Failed", + "description": "The operation failed." + }, + { + "value": "Canceled", + "description": "The operation was canceled." + }, + { + "value": "Running", + "description": "The operation is running." + } + ] + } + }, "EnvironmentDeployOperation": { "type": "object", "description": "Information about a deploy operation on an environment.", From 30f653bcbeb27de1967396e8f84cb337103301c8 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Thu, 22 Jun 2023 12:03:40 -0400 Subject: [PATCH 20/23] Consolidate on "sourceUri" for consistency with "uri" property --- .../preview/2023-07-01-preview/devbox.json | 11 ++++++++--- .../examples/DevBoxActions_Delay.json | 1 + .../examples/DevBoxActions_DelayMultiple.json | 2 ++ .../DevBoxActions_DelayMultipleWithError.json | 1 + .../examples/DevBoxActions_Get.json | 1 + .../examples/DevBoxActions_List.json | 2 ++ .../2023-07-01-preview/examples/Schedules_Get.json | 2 +- .../2023-07-01-preview/examples/Schedules_List.json | 2 +- .../examples/Schedules_ListByProject.json | 2 +- 9 files changed, 18 insertions(+), 6 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index d691b87a0558..0122aef831c0 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -1492,8 +1492,8 @@ "description": "Display name for the Schedule", "type": "string" }, - "sourceId": { - "description": "The id of the resource that this schedule belongs to", + "sourceUri": { + "description": "The URI of the resource that this schedule belongs to", "type": "string" }, "sourceType": { @@ -1520,7 +1520,7 @@ "required": [ "uri", "name", - "sourceId", + "sourceUri", "sourceType", "type", "frequency", @@ -1964,6 +1964,10 @@ "description": "The id of the resource which triggered this action", "type": "string" }, + "sourceUri": { + "description": "The URI of the resource which triggered this action", + "type": "string" + }, "sourceType": { "description": "The type of the resource which triggered this action", "$ref": "#/definitions/DevBoxActionSourceType" @@ -1983,6 +1987,7 @@ "uri", "actionType", "sourceId", + "sourceUri", "sourceType" ] }, diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json index 2dacb9d070ce..c0043e11b125 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json @@ -14,6 +14,7 @@ "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", "name": "schedule-default", "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", "sourceId": "/projects/myProject/pools/myPool/schedules/default", "sourceType": "Schedule", "suspendedUntil": "2022-09-30T17:00:00Z", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json index e8cdc2dc3612..79a408491961 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultiple.json @@ -20,6 +20,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", "sourceType": "Schedule", "suspendedUntil": "2022-09-30T17:00:00Z", "next": { @@ -36,6 +37,7 @@ "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", "sourceType": "Pool", "suspendedUntil": "2022-09-30T17:00:00Z" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json index b40d178dbc63..f5682d004dcd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_DelayMultipleWithError.json @@ -29,6 +29,7 @@ "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", "sourceType": "Pool", "suspendedUntil": "2022-09-30T17:00:00Z" } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json index 261ae16342f5..03d776029ba4 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Get.json @@ -14,6 +14,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", "sourceType": "Schedule", "next": { "scheduledTime": "2022-09-30T17:00:00Z" diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json index 9fbdb3c19949..ece0bcd6560d 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_List.json @@ -15,6 +15,7 @@ "name": "idle-hibernateondisconnect", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", "sourceType": "Pool", "next": { "scheduledTime": "2022-09-30T15:23:00Z" @@ -25,6 +26,7 @@ "name": "schedule-default", "actionType": "Stop", "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", "sourceType": "Schedule", "suspendedUntil": "2022-09-30T17:00:00Z", "next": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json index 4a321e6326c6..820b5ca7c788 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_Get.json @@ -11,7 +11,7 @@ "body": { "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", - "sourceId": "/projects/myProject/pools/DevPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", "sourceType": "Pool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json index 5aab1c67b31c..dd77c735bdde 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_List.json @@ -12,7 +12,7 @@ { "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", - "sourceId": "/projects/myProject/pools/DevPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", "sourceType": "Pool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json index 3f880ebc4d66..b90e3bad241e 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Schedules_ListByProject.json @@ -11,7 +11,7 @@ { "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", "name": "default", - "sourceId": "/projects/myProject/pools/DevPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", "sourceType": "Pool", "type": "StopDevBox", "timeZone": "America/Los_Angeles", From 0d9676288b1851be9e3eab7f2e295c813737ff26 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Fri, 23 Jun 2023 13:43:20 -0400 Subject: [PATCH 21/23] Description updates --- .../preview/2023-07-01-preview/devbox.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index 0122aef831c0..e61bf1a6f777 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -158,7 +158,7 @@ "$ref": "devcenter.json#/parameters/ProjectNameParameter" } ], - "description": "Lists available schedules for all resources within a project.", + "description": "Lists all schedules within a project that are configured by your project administrator.", "operationId": "DevBoxes_ListSchedulesByProject", "responses": { "200": { @@ -213,7 +213,7 @@ "$ref": "#/parameters/PoolNameParameter" } ], - "description": "Lists available schedules for a pool.", + "description": "Lists all schedules within a pool that are configured by your project administrator.", "operationId": "DevBoxes_ListSchedulesByPool", "responses": { "200": { From 4dbaf490c0b5cc57348137bbbb3a7fbf9fc73cc6 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Mon, 26 Jun 2023 10:15:28 -0400 Subject: [PATCH 22/23] Add NotStarted state --- .../preview/2023-07-01-preview/devbox.json | 21 ++++++++++++------- .../2023-07-01-preview/environments.json | 21 ++++++++++++------- 2 files changed, 26 insertions(+), 16 deletions(-) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index e61bf1a6f777..efe1a22d9a47 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -2215,10 +2215,11 @@ "DevBoxOperationStatus": { "type": "string", "enum": [ + "NotStarted", + "Running", "Succeeded", - "Failed", "Canceled", - "Running" + "Failed" ], "description": "The status of a Dev Box operation.", "x-ms-enum": { @@ -2226,20 +2227,24 @@ "modelAsString": true, "values": [ { - "value": "Succeeded", - "description": "The operation succeeded." + "value": "NotStarted", + "description": "The operation has not started." }, { - "value": "Failed", - "description": "The operation failed." + "value": "Running", + "description": "The operation is running." + }, + { + "value": "Succeeded", + "description": "The operation succeeded." }, { "value": "Canceled", "description": "The operation was canceled." }, { - "value": "Running", - "description": "The operation is running." + "value": "Failed", + "description": "The operation failed." } ] } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index c5f42b3e3a8b..59baf65714c0 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -1214,10 +1214,11 @@ "EnvironmentOperationStatus": { "type": "string", "enum": [ + "NotStarted", + "Running", "Succeeded", - "Failed", "Canceled", - "Running" + "Failed" ], "description": "The status of an environment operation.", "x-ms-enum": { @@ -1225,20 +1226,24 @@ "modelAsString": true, "values": [ { - "value": "Succeeded", - "description": "The operation succeeded." + "value": "NotStarted", + "description": "The operation has not started." }, { - "value": "Failed", - "description": "The operation failed." + "value": "Running", + "description": "The operation is running." + }, + { + "value": "Succeeded", + "description": "The operation succeeded." }, { "value": "Canceled", "description": "The operation was canceled." }, { - "value": "Running", - "description": "The operation is running." + "value": "Failed", + "description": "The operation failed." } ] } From d301413df2b25739918b4c5d83a0fdb4aa5bca18 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Thu, 29 Jun 2023 12:03:40 -0400 Subject: [PATCH 23/23] Add default response and missing LRO options to resolve LintDiff warning. --- .../preview/2023-07-01-preview/devbox.json | 3 +++ .../preview/2023-07-01-preview/environments.json | 12 ++++++++++++ 2 files changed, 15 insertions(+) diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json index efe1a22d9a47..e29c9fbe5bbd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json @@ -821,6 +821,9 @@ "description": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", "operationId": "DevBoxes_RepairDevBox", "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, "responses": { "202": { "description": "The request was accepted.", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json index 59baf65714c0..01a7079126d9 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json @@ -454,6 +454,18 @@ "schema": { "type": "file" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } } }, "x-ms-examples": {