From 0c75ca9b507910ed430eec31bae2e7677c411ff1 Mon Sep 17 00:00:00 2001 From: chrissmiller Date: Mon, 14 Nov 2022 11:00:56 -0500 Subject: [PATCH] [Hub Generated] Publish private branch 'release-devcenter-Microsoft.DevCenter-2022-11-11-preview' (#21454) * Adds base for updating Microsoft.DevCenter from version preview/2022-03-01-preview to version 2022-11-11-preview * Updates readme * Updates API version in new specs and examples * Add updated examples and spec * Run prettier and resolve swagger checks * Update client loc and format * Restore URL format to satisfy HostParametersValidation * Update host template naming * Update to use "endpoint" * Update formats and naming * Remove artifacts * Remove url formatting * Expose hibernation support info * Update naming based on feedback, restore hibernate query param * Run prettier, fix ref * Incorporate example changes * Align param naming * Align user ID naming * Remove unnecessary LRO options * Remove delete environment LRO options * Fix reference that breaks swagger api view * Add suppression * Fix suppression format --- .../preview/2022-11-11-preview/devbox.json | 1468 +++++++++++++++++ .../preview/2022-11-11-preview/devcenter.json | 301 ++++ .../2022-11-11-preview/environments.json | 1273 ++++++++++++++ .../examples/CatalogItemVersions_Get.json | 74 + .../CatalogItemVersions_ListByProject.json | 77 + .../examples/CatalogItems_Get.json | 17 + .../examples/CatalogItems_ListByProject.json | 20 + .../examples/DevBoxes_Create.json | 69 + .../examples/DevBoxes_Delete.json | 17 + .../examples/DevBoxes_Get.json | 37 + .../DevBoxes_GetRemoteConnection.json | 16 + .../examples/DevBoxes_List.json | 38 + .../DevBoxes_ListByUserByProject.json | 40 + .../examples/DevBoxes_Start.json | 16 + .../examples/DevBoxes_Stop.json | 17 + .../EnvironmentTypes_ListByProject.json | 18 + .../Environments_CreateByCatalogItem.json | 54 + .../Environments_CreateWithAutoExpire.json | 72 + .../examples/Environments_CustomAction.json | 24 + .../examples/Environments_Delete.json | 18 + .../examples/Environments_DeployAction.json | 24 + .../examples/Environments_Get.json | 27 + .../examples/Environments_ListByProject.json | 29 + .../Environments_ListByProjectByUser.json | 30 + .../examples/Environments_Patch.json | 30 + .../examples/Pools_Get.json | 32 + .../examples/Pools_List.json | 55 + .../examples/Projects_Get.json | 15 + .../examples/Projects_ListByDevCenter.json | 18 + .../examples/Schedules_Get.json | 20 + .../examples/Schedules_List.json | 23 + .../examples/UpcomingActions_Delay.json | 23 + .../examples/UpcomingActions_Get.json | 22 + .../examples/UpcomingActions_List.json | 25 + .../examples/UpcomingActions_Skip.json | 13 + specification/devcenter/data-plane/readme.md | 21 +- 36 files changed, 4070 insertions(+), 3 deletions(-) create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/environments.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Create.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Delete.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_ListByUserByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Start.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Stop.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/EnvironmentTypes_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateByCatalogItem.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateWithAutoExpire.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CustomAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Delete.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_DeployAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_ListByProjectByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Patch.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_ListByDevCenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Schedules_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Schedules_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Delay.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Skip.json diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json new file mode 100644 index 000000000000..a77e7f9abc40 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json @@ -0,0 +1,1468 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-11-11-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": "#/parameters/PoolNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "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 updates 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, + "responses": { + "202": { + "description": "The request was accepted", + "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, + "responses": { + "202": { + "description": "The request was accepted", + "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, + "responses": { + "202": { + "description": "The request was accepted", + "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}/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}/upcomingActions": { + "get": { + "tags": [ + "Upcoming Actions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Lists upcoming actions on a Dev Box.", + "operationId": "DevBoxes_ListUpcomingActions", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpcomingActionsListResult" + } + }, + "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_ListUpcomingActions": { + "$ref": "./examples/UpcomingActions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/UpcomingAction" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}": { + "get": { + "tags": [ + "Upcoming Actions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/UpcomingActionIdParameter" + } + ], + "description": "Gets an Upcoming Action.", + "operationId": "DevBoxes_GetUpcomingAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpcomingAction" + } + }, + "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_GetUpcomingAction": { + "$ref": "./examples/UpcomingActions_Get.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:skip": { + "post": { + "tags": [ + "Upcoming Actions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/UpcomingActionIdParameter" + } + ], + "description": "Skips an Upcoming Action.", + "operationId": "DevBoxes_SkipUpcomingAction", + "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_SkipUpcomingAction": { + "$ref": "./examples/UpcomingActions_Skip.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:delay": { + "post": { + "tags": [ + "Upcoming Actions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/UpcomingActionIdParameter" + }, + { + "$ref": "#/parameters/DelayUntilParameter" + } + ], + "description": "Delays an Upcoming Action.", + "operationId": "DevBoxes_DelayUpcomingAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpcomingAction" + } + }, + "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_DelayUpcomingAction": { + "$ref": "./examples/UpcomingActions_Delay.json" + } + } + } + } + }, + "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", + "readOnly": true + }, + "location": { + "description": "Azure region where Dev Boxes in the pool are located", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The operating system type of Dev Boxes in this pool", + "$ref": "#/definitions/OsType", + "readOnly": true + }, + "hardwareProfile": { + "description": "Hardware settings for the Dev Boxes created in this pool", + "$ref": "#/definitions/HardwareProfile", + "readOnly": true + }, + "hibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "$ref": "#/definitions/HibernateSupport", + "readOnly": true + }, + "storageProfile": { + "description": "Storage settings for Dev Box created in this pool", + "$ref": "#/definitions/StorageProfile", + "readOnly": true + }, + "imageReference": { + "description": "Image settings for Dev Boxes create in this pool", + "$ref": "#/definitions/ImageReference", + "readOnly": true + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes.", + "$ref": "#/definitions/LocalAdminStatus" + } + } + }, + "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", + "readOnly": true + }, + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledType", + "readOnly": true + }, + "frequency": { + "description": "The frequency of this scheduled task.", + "$ref": "#/definitions/ScheduledFrequency", + "readOnly": true + }, + "time": { + "description": "The target time to trigger the action. The format is HH:MM.", + "type": "string", + "readOnly": true + }, + "timeZone": { + "description": "The IANA timezone id at which the schedule should execute.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true + } + }, + "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 DevBox 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 + }, + "errorDetails": { + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true, + "$ref": "devcenter.json#/definitions/ProvisioningError" + }, + "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 + } + }, + "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 RDP connection information", + "type": "object", + "properties": { + "webUrl": { + "description": "URL to open a browser based RDP session", + "type": "string", + "readOnly": true + }, + "rdpConnectionUrl": { + "description": "Link to open a Remote Desktop session", + "type": "string", + "readOnly": true + } + } + }, + "PowerState": { + "type": "string", + "enum": [ + "Unknown", + "Deallocated", + "PoweredOff", + "Running", + "Hibernated" + ], + "description": "The power states of a Dev Box.", + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is supported and enabled or disabled. Unknown hibernate support is represented as null.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true + } + }, + "LocalAdminStatus": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true + } + }, + "UpcomingActionsListResult": { + "type": "object", + "description": "The Upcoming Action list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/UpcomingAction" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "UpcomingAction": { + "type": "object", + "description": "An upcoming Action.", + "properties": { + "id": { + "description": "Uniquely identifies the action.", + "type": "string", + "readOnly": true + }, + "actionType": { + "description": "The action that will be taken.", + "$ref": "#/definitions/UpcomingActionType", + "readOnly": true + }, + "reason": { + "description": "The reason for this action.", + "$ref": "#/definitions/UpcomingActionReason", + "readOnly": true + }, + "scheduledTime": { + "description": "The target time the action will be triggered (UTC).", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "originalScheduledTime": { + "description": "The original scheduled time for the action (UTC).", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "sourceId": { + "description": "The id of the resource which triggered this action", + "type": "string", + "readOnly": true + } + } + }, + "UpcomingActionType": { + "description": "The upcoming action types.", + "type": "string", + "enum": [ + "Stop" + ], + "x-ms-enum": { + "name": "UpcomingActionType", + "modelAsString": true + } + }, + "UpcomingActionReason": { + "description": "The reason for the upcoming action.", + "type": "string", + "enum": [ + "Schedule" + ], + "x-ms-enum": { + "name": "UpcomingActionReason", + "modelAsString": true + } + } + }, + "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" + }, + "UpcomingActionIdParameter": { + "description": "The upcoming action id.", + "in": "path", + "name": "upcomingActionId", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "maxLength": 36, + "x-ms-parameter-location": "method" + }, + "DelayUntilParameter": { + "name": "delayUntil", + "description": "The delayed action time (UTC).", + "required": true, + "type": "string", + "format": "date-time", + "in": "query", + "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" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json new file mode 100644 index 000000000000..8b000d3353c1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json @@ -0,0 +1,301 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-11-11-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", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the project.", + "readOnly": true + } + } + }, + "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." + } + } + }, + "ProvisioningError": { + "description": "Error details", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "EnableStatus": { + "description": "Enable or disable status. Indicates whether the property applied to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + } + }, + "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/2022-11-11-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/environments.json new file mode 100644 index 000000000000..ada6e53bf68b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/environments.json @@ -0,0 +1,1273 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-11-11-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 a environment.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "operationId": "Environments_CreateOrUpdateEnvironment", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "200": { + "description": "Succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "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_CreateByCatalogItem": { + "$ref": "./examples/Environments_CreateByCatalogItem.json" + }, + "Environments_CreateWithAutoExpire": { + "$ref": "./examples/Environments_CreateWithAutoExpire.json" + } + } + }, + "patch": { + "tags": [ + "Environments" + ], + "description": "Partially updates an environment", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable environment properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdateProperties" + } + } + ], + "operationId": "Environments_UpdateEnvironment", + "responses": { + "200": { + "description": "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_UpdateEnvironment": { + "$ref": "./examples/Environments_Patch.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": { + "200": { + "description": "Deletion was successful." + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "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": { + "Environments_DeleteEnvironment": { + "$ref": "./examples/Environments_Delete.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}:deploy": { + "post": { + "tags": [ + "Environment Actions" + ], + "description": "Executes a deploy action", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Action properties overriding the environment's default values.", + "required": true, + "schema": { + "$ref": "#/definitions/ActionRequest" + } + } + ], + "operationId": "Environments_DeployEnvironmentAction", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "200": { + "description": "The environment deploy action succeeded." + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "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_DeployEnvironmentAction": { + "$ref": "./examples/Environments_DeployAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}:custom": { + "post": { + "tags": [ + "Environment Actions" + ], + "description": "Executes a custom action", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Action properties overriding the environment's default values.", + "required": true, + "schema": { + "$ref": "#/definitions/ActionRequest" + } + } + ], + "operationId": "Environments_CustomEnvironmentAction", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "200": { + "description": "The environment custom action execution succeeded." + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "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_CustomEnvironmentAction": { + "$ref": "./examples/Environments_CustomAction.json" + } + } + } + }, + "/projects/{projectName}/catalogItems": { + "get": { + "tags": [ + "Catalog Items" + ], + "description": "Lists latest version of all catalog items available for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListCatalogItems", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogItemListResult" + } + }, + "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_ListCatalogItems": { + "$ref": "./examples/CatalogItems_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogItems/{catalogItemId}": { + "get": { + "tags": [ + "Catalog Items" + ], + "description": "Get a catalog item from a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogItemIdentifierParameter" + } + ], + "operationId": "Environments_GetCatalogItem", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogItem" + } + }, + "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_GetCatalogItem": { + "$ref": "./examples/CatalogItems_Get.json" + } + } + } + }, + "/projects/{projectName}/catalogItems/{catalogItemId}/versions": { + "get": { + "tags": [ + "Catalog Item Versions" + ], + "description": "List all versions of a catalog item from a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/CatalogItemIdentifierParameter" + } + ], + "operationId": "Environments_ListCatalogItemVersions", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogItemVersionListResult" + } + }, + "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_ListCatalogItemVersions": { + "$ref": "./examples/CatalogItemVersions_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogItems/{catalogItemId}/versions/{version}": { + "get": { + "tags": [ + "Catalog Item Versions" + ], + "description": "Get a specific catalog item version from a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogItemIdentifierParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "operationId": "Environments_GetCatalogItemVersion", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogItemVersion" + } + }, + "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_GetCatalogItemVersion": { + "$ref": "./examples/CatalogItemVersions_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": { + "ActionRequest": { + "description": "Action request", + "type": "object", + "properties": { + "actionId": { + "type": "string", + "description": "The Catalog Item action id to execute" + }, + "parameters": { + "type": "object", + "description": "Parameters object for the Action" + } + }, + "required": [ + "actionId" + ] + }, + "EnvironmentUpdateProperties": { + "description": "Properties of an environment. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the Environment." + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog." + }, + "catalogItemName": { + "type": "string", + "description": "Name of the catalog item." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the deploy action" + }, + "scheduledTasks": { + "description": "Set of supported scheduled tasks to help manage cost.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ScheduledTask" + } + }, + "tags": { + "description": "Key value pairs that will be applied to resources deployed in this environment as tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "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." + }, + "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 + } + }, + "required": [ + "environmentType", + "catalogName", + "catalogItemName" + ] + }, + "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" + ] + }, + "CatalogItemListResult": { + "description": "Results of the catalog item list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItem" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "CatalogItem": { + "description": "A catalog item.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the catalog item.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the catalog item.", + "type": "string", + "readOnly": true + }, + "catalogName": { + "description": "Name of the catalog.", + "type": "string", + "readOnly": true + } + } + }, + "CatalogItemVersionListResult": { + "description": "Results of the catalog item list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemVersion" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "CatalogItemVersion": { + "description": "A catalog item version.", + "type": "object", + "properties": { + "catalogItemId": { + "description": "Unique identifier of the catalog item.", + "type": "string", + "readOnly": true + }, + "catalogItemName": { + "description": "Name of the catalog item.", + "type": "string", + "readOnly": true + }, + "catalogName": { + "description": "Name of the catalog.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the catalog item.", + "type": "string", + "readOnly": true + }, + "summary": { + "description": "A short summary of the catalog item.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "A long description of the catalog item.", + "type": "string", + "readOnly": true + }, + "templatePath": { + "description": "Path to the catalog item entrypoint file.", + "type": "string", + "readOnly": true + }, + "parametersSchema": { + "type": "string", + "readOnly": true, + "description": "JSON schema defining the parameters object passed to actions" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemParameter" + }, + "description": "Input parameters passed to actions", + "readOnly": true + }, + "actions": { + "type": "array", + "description": "Custom actions for the catalog item.", + "items": { + "$ref": "#/definitions/CatalogItemAction" + }, + "readOnly": true + }, + "runner": { + "type": "string", + "description": "The default container image to use to execute actions", + "readOnly": true + }, + "status": { + "description": "Defines whether the specific catalog item version can be used.", + "$ref": "devcenter.json#/definitions/EnableStatus" + }, + "eligibleForLatestVersion": { + "description": "Whether the version is eligible to be the latest version.", + "type": "boolean" + } + } + }, + "CatalogItemAction": { + "description": "An action that can be taken on a catalog item.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the action", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name of the action", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the action", + "readOnly": true + }, + "parametersSchema": { + "type": "string", + "description": "JSON schema defining the parameters specific to the custom action", + "readOnly": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemParameter" + }, + "description": "Input parameters passed to the action", + "readOnly": true + }, + "type": { + "description": "The action type.", + "readOnly": true, + "$ref": "#/definitions/ActionType" + }, + "typeName": { + "type": "string", + "description": "Name of the custom action type", + "readOnly": true + }, + "runner": { + "type": "string", + "description": "The container image to use to execute the action", + "readOnly": true + } + } + }, + "ActionType": { + "type": "string", + "enum": [ + "Custom", + "Deploy", + "Delete" + ], + "description": "The type of action.", + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "value": "Custom", + "description": "A custom action defined in the catalog item.", + "name": "CustomAction" + }, + { + "value": "Deploy", + "description": "The action to deploy the environment resources.", + "name": "DeployAction" + }, + { + "value": "Delete", + "description": "The action to delete the environment resources.", + "name": "DeleteAction" + } + ] + } + }, + "CatalogItemParameter": { + "type": "object", + "description": "Properties of an Catalog Item parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name of the parameter", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the parameter", + "readOnly": true + }, + "default": { + "type": "object", + "description": "Default value of the parameter", + "readOnly": true + }, + "type": { + "description": "A string of one of the basic JSON types (number, integer, null, array, object, boolean, string)", + "readOnly": true, + "$ref": "#/definitions/ParameterType" + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a value.", + "readOnly": true + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required", + "readOnly": true + }, + "allowed": { + "type": "array", + "items": { + "type": "object" + }, + "minItems": 1, + "uniqueItems": true, + "description": "An array of allowed values", + "readOnly": true + } + } + }, + "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", + "readOnly": true + }, + "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", + "readOnly": true + }, + "status": { + "description": "Defines whether this Environment Type can be used in this Project.", + "$ref": "devcenter.json#/definitions/EnableStatus", + "readOnly": true + } + } + }, + "ScheduledTask": { + "description": "Scheduled task to auto-expire an environment.", + "type": "object", + "properties": { + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledTaskType" + }, + "enabled": { + "description": "Indicates whether or not this scheduled task is enabled.", + "$ref": "devcenter.json#/definitions/EnableStatus" + }, + "startTime": { + "description": "Date/time by which the environment should expire", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "type", + "startTime" + ] + }, + "ScheduledTaskType": { + "type": "string", + "enum": [ + "AutoExpire" + ], + "description": "The supported types for a scheduled task.", + "x-ms-enum": { + "name": "ScheduledTaskType", + "modelAsString": true, + "values": [ + { + "value": "AutoExpire", + "description": "The scheduled task to expire the environment after a set period.", + "name": "AutoExpireScheduledTask" + } + ] + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ], + "description": "The type of data a parameter accepts.", + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true + } + } + }, + "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" + }, + "CatalogItemIdentifierParameter": { + "name": "catalogItemId", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.:]{2,216}$", + "minLength": 3, + "maxLength": 216, + "description": "The unique id of the catalog item.", + "x-ms-parameter-location": "method" + }, + "VersionParameter": { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9]{1,20}.[0-9]{1,20}.[0-9]{1,20}$|^latest$", + "minLength": 3, + "maxLength": 63, + "description": "The version of the catalog item.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_Get.json new file mode 100644 index 000000000000..6c0db9a063f9 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogItemId": "foo", + "version": "1.0.0" + }, + "responses": { + "200": { + "body": { + "catalogItemId": "foo", + "catalogItemName": "foo", + "catalogName": "main", + "version": "1.0.0", + "status": "Enabled", + "eligibleForLatestVersion": true, + "summary": "Hello world template", + "description": "Hello world template to deploy a basic API service", + "templatePath": "azuredeploy.json", + "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 + } + ], + "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\"]}", + "runner": "devcenter/arm", + "actions": [ + { + "id": "reset", + "name": "Reset", + "description": "Reset the environment to its original state.", + "type": "Custom", + "typeName": "reset" + }, + { + "id": "clear", + "name": "Clear", + "description": "Delete all resources, but keep the environment alive.", + "type": "Custom", + "typeName": "clear" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_ListByProject.json new file mode 100644 index 000000000000..bdeed87f73ad --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItemVersions_ListByProject.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogItemId": "foo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "catalogItemId": "foo", + "catalogItemName": "foo", + "catalogName": "main", + "version": "1.0.0", + "status": "Enabled", + "eligibleForLatestVersion": true, + "summary": "Hello world template", + "description": "Hello world template to deploy a basic API service", + "templatePath": "azuredeploy.json", + "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 + } + ], + "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\"]}", + "runner": "devcenter/arm", + "actions": [ + { + "id": "reset", + "name": "Reset", + "description": "Reset the environment to its original state.", + "type": "Custom", + "typeName": "reset" + }, + { + "id": "clear", + "name": "Clear", + "description": "Delete all resources, but keep the environment alive.", + "type": "Custom", + "typeName": "clear" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_Get.json new file mode 100644 index 000000000000..03e56bd899a7 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogItemId": "foo" + }, + "responses": { + "200": { + "body": { + "id": "foo", + "name": "foo", + "catalogName": "main" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_ListByProject.json new file mode 100644 index 000000000000..e0892d26395a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/CatalogItems_ListByProject.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "foo", + "name": "foo", + "catalogName": "main" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Create.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Create.json new file mode 100644 index 000000000000..e943b9375a24 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Create.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2022-11-11-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://ContosoDevCenter.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/2022-11-11-preview/examples/DevBoxes_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Delete.json new file mode 100644 index 000000000000..664b7d764008 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Get.json new file mode 100644 index 000000000000..9da253dad49d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2022-11-11-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/2022-11-11-preview/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..483349cfc8f8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2022-11-11-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/2022-11-11-preview/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_List.json new file mode 100644 index 000000000000..151b47e23289 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "api-version": "2022-11-11-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/2022-11-11-preview/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_ListByUserByProject.json new file mode 100644 index 000000000000..d4f8cb976b5a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_ListByUserByProject.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2022-11-11-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/2022-11-11-preview/examples/DevBoxes_Start.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Start.json new file mode 100644 index 000000000000..33cbaa07a95c --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Start.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Stop.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Stop.json new file mode 100644 index 000000000000..e7714a0083fb --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/DevBoxes_Stop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-11-11-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://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/EnvironmentTypes_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/EnvironmentTypes_ListByProject.json new file mode 100644 index 000000000000..b33c1a7bdcda --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/EnvironmentTypes_ListByProject.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "devtestenv" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateByCatalogItem.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateByCatalogItem.json new file mode 100644 index 000000000000..b712e3b1816a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateByCatalogItem.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "description": "Personal Dev Environment", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydevenv", + "description": "Personal Dev Environment", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded" + } + }, + "201": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "name": "mydevenv", + "description": "Personal Dev Environment", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "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/2022-11-11-preview/examples/Environments_CreateWithAutoExpire.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateWithAutoExpire.json new file mode 100644 index 000000000000..042748c48dea --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CreateWithAutoExpire.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "body": { + "description": "Personal Dev Environment", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "scheduledTasks": { + "autoExpire": { + "type": "AutoExpire", + "startTime": "2022-01-01T00:01:00Z" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydevenv", + "description": "Personal Dev Environment", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "scheduledTasks": { + "autoExpire": { + "type": "AutoExpire", + "startTime": "2022-01-01T00:01:00Z" + } + }, + "provisioningState": "Succeeded" + } + }, + "201": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "name": "mydevenv", + "description": "Personal Dev Environment", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "scheduledTasks": { + "autoExpire": { + "type": "AutoExpire", + "startTime": "2022-01-01T00:01:00Z" + } + }, + "provisioningState": "Creating" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CustomAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CustomAction.json new file mode 100644 index 000000000000..a2d49646b358 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_CustomAction.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "body": { + "actionId": "someCustomActionId", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Delete.json new file mode 100644 index 000000000000..c91204bcbd07 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_DeployAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_DeployAction.json new file mode 100644 index 000000000000..bc249b4c834a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_DeployAction.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "body": { + "actionId": "deploy", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://ContosoDevCenter.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Get.json new file mode 100644 index 000000000000..01f052e930bd --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "name": "mydevenv", + "description": "Personal Dev Environment 2", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "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/2022-11-11-preview/examples/Environments_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_ListByProject.json new file mode 100644 index 000000000000..65820f38cb05 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_ListByProject.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydevenv", + "description": "Personal Dev Environment 2", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "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/2022-11-11-preview/examples/Environments_ListByProjectByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_ListByProjectByUser.json new file mode 100644 index 000000000000..8c7416fbeaec --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_ListByProjectByUser.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydevenv", + "description": "Personal Dev Environment 2", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "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/2022-11-11-preview/examples/Environments_Patch.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Patch.json new file mode 100644 index 000000000000..9ff3b8e01362 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Environments_Patch.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "body": { + "description": "Personal Dev Environment 2" + } + }, + "responses": { + "200": { + "body": { + "name": "mydevenv", + "description": "Personal Dev Environment 2", + "environmentType": "DevTest", + "catalogName": "main", + "catalogItemName": "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/2022-11-11-preview/examples/Pools_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..1f48bc7ebe17 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2022-11-11-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" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_List.json new file mode 100644 index 000000000000..e852cfdbe4a7 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Pools_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2022-11-11-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" + } + }, + { + "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" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_Get.json new file mode 100644 index 000000000000..34a63a1059fc --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2022-11-11-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/2022-11-11-preview/examples/Projects_ListByDevCenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_ListByDevCenter.json new file mode 100644 index 000000000000..1219c4cbcaa2 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Projects_ListByDevCenter.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2022-11-11-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/2022-11-11-preview/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Schedules_Get.json new file mode 100644 index 000000000000..384fb5eebad7 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-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": "2022-11-11-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/2022-11-11-preview/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/Schedules_List.json new file mode 100644 index 000000000000..8f770d7f8ea0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-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": "2022-11-11-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Delay.json new file mode 100644 index 000000000000..b668079d0b86 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Delay.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "upcomingActionId": "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7", + "delayUntil": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "id": "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7", + "actionType": "StopDevBox", + "reason": "Schedule", + "scheduledTime": "2022-09-30T17:00:00Z", + "originalScheduledTime": "2021-09-30T12:00:00Z", + "sourceId": "/projects/myProject/pools/myPool/schedules/mySchedule" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Get.json new file mode 100644 index 000000000000..23c808c7f5d6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "upcomingActionId": "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7" + }, + "responses": { + "200": { + "body": { + "id": "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7", + "actionType": "StopDevBox", + "reason": "Schedule", + "scheduledTime": "2022-09-30T17:00:00Z", + "originalScheduledTime": "2021-09-30T12:00:00Z", + "sourceId": "/projects/myProject/pools/myPool/schedules/mySchedule" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_List.json new file mode 100644 index 000000000000..0c021e04bad1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7", + "actionType": "StopDevBox", + "reason": "Schedule", + "scheduledTime": "2022-09-30T17:00:00Z", + "originalScheduledTime": "2021-09-30T12:00:00Z", + "sourceId": "/projects/myProject/pools/myPool/schedules/mySchedule" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Skip.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Skip.json new file mode 100644 index 000000000000..25fd0b1854e6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/examples/UpcomingActions_Skip.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2022-11-11-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "upcomingActionId": "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 59d5afc20570..f78813ff652b 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -24,17 +24,32 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the devcenter. -```yaml +``` yaml openapi-type: data-plane azure-arm: false -tag: package-2022-03-01-preview +tag: package-preview-2022-11 ``` + +### Tag: package-preview-2022-11 + +These settings apply only when `--tag=package-preview-2022-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2022-11' +input-file: + - Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json + - Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json + - Microsoft.DevCenter/preview/2022-11-11-preview/environments.json + +directive: + - suppress: HostParametersValidation + reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen +``` ### Tag: package-2022-03-01-preview These settings apply only when `--tag=package-2022-03-01-preview` is specified on the command line. -```yaml $(tag) == 'package-2022-03-01-preview' +``` yaml $(tag) == 'package-2022-03-01-preview' input-file: - Microsoft.DevCenter/preview/2022-03-01-preview/devcenter.json - Microsoft.DevCenter/preview/2022-03-01-preview/devbox.json