swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Environments API schemes: - https tags: - name: Environments paths: /environments: get: operationId: microsoftAzureEnvironmentsListall description: List a collection of environments across workspaces. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedEnvironmentAll' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Environments_ListAll: $ref: ./examples/Environments_ListAll.json summary: Microsoft Azure Get Environments tags: - Environments /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: microsoftAzureEnvironmentsListenvironments 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 summary: Microsoft Azure Get Projects Projectname Environments /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: microsoftAzureEnvironmentsListenvironmentsbyuser 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 summary: Microsoft Azure Get Projects Projectname Users Userid Environments /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: microsoftAzureEnvironmentsGetenvironmentbyuser responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Environment_2' 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 summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname put: tags: - Environments description: Creates or updates an environment. parameters: - $ref: devcenter.json#/parameters/ApiVersionParameter - $ref: devcenter.json#/parameters/ProjectNameParameter - $ref: devcenter.json#/parameters/UserIdParameter - $ref: '#/parameters/EnvironmentNameParameter' - name: body in: body description: Represents an environment. required: true schema: $ref: '#/definitions/Environment_2' operationId: microsoftAzureEnvironmentsCreateorreplaceenvironment x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: original-uri responses: '201': description: Created. Operation will complete asynchronously. schema: $ref: '#/definitions/Environment_2' headers: Operation-Location: description: URL to query for status of the operation. type: string default: description: Error response describing why the operation failed. schema: $ref: devcenter.json#/definitions/CloudError headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: Environments_CreateByEnvironmentDefinition: $ref: ./examples/Environments_CreateByEnvironmentDefinition.json summary: Microsoft Azure Put Projects Projectname Users Userid Environments Environmentname 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: microsoftAzureEnvironmentsDeleteenvironment x-ms-long-running-operation: true responses: '202': description: Accepted. Operation will complete asynchronously. schema: $ref: devcenter.json#/definitions/OperationStatus headers: Operation-Location: description: URL to query for status of the operation. type: string '204': description: Deletion was successful or resource does not exist. default: description: Error response describing why the operation failed. schema: $ref: devcenter.json#/definitions/CloudError headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: Environments_DeleteEnvironment: $ref: ./examples/Environments_Delete.json summary: Microsoft Azure Delete Projects Projectname Users Userid Environments Environmentname /projects/{projectName}/users/{userId}/environments/{environmentName}/operations: get: tags: - Environments description: Lists operations on the environment which have occurred within the past 90 days parameters: - $ref: devcenter.json#/parameters/ApiVersionParameter - $ref: devcenter.json#/parameters/TopParameter - $ref: devcenter.json#/parameters/FilterParameter - $ref: devcenter.json#/parameters/ProjectNameParameter - $ref: devcenter.json#/parameters/UserIdParameter - $ref: '#/parameters/EnvironmentNameParameter' operationId: microsoftAzureEnvironmentsListoperations responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/EnvironmentOperationListResult' default: description: Error response describing why the operation failed. schema: $ref: devcenter.json#/definitions/CloudError headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: EnvironmentOperations_ListByEnvironment: $ref: ./examples/EnvironmentOperations_ListByEnvironment.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}: get: tags: - Environments description: Gets an environment action result. parameters: - $ref: devcenter.json#/parameters/ApiVersionParameter - $ref: devcenter.json#/parameters/ProjectNameParameter - $ref: devcenter.json#/parameters/UserIdParameter - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/EnvironmentOperationIdParameter' operationId: microsoftAzureEnvironmentsGetoperation responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/EnvironmentOperation' default: description: Error response describing why the operation failed. schema: $ref: devcenter.json#/definitions/CloudError headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: EnvironmentOperations_GetByEnvironment: $ref: ./examples/EnvironmentOperations_GetByEnvironment.json summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations Operationid /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs: get: tags: - Environments description: Gets the logs for an operation on an environment. produces: - text/plain parameters: - $ref: devcenter.json#/parameters/ApiVersionParameter - $ref: devcenter.json#/parameters/ProjectNameParameter - $ref: devcenter.json#/parameters/UserIdParameter - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/EnvironmentOperationIdParameter' operationId: microsoftAzureEnvironmentsGetlogsbyoperation responses: '200': description: OK. The request has succeeded. schema: type: file default: description: Error response describing why the operation failed. schema: $ref: devcenter.json#/definitions/CloudError headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: EnvironmentOperations_GetLogs: $ref: ./examples/EnvironmentOperations_GetLogs.json summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations Operationid Logs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments : get: tags: - Environments description: List environments in a given user profile. operationId: microsoftAzureEnvironmentsList parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labName in: path description: The name of the lab. required: true type: string - name: userName in: path description: The name of the user profile. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($select=deploymentProperties)''' type: string - name: $filter in: query description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')' type: string - name: $top in: query description: 'The maximum number of resources to return from the operation. Example: ''$top=10''' type: integer format: int32 - name: $orderby in: query description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc''' type: string - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/DtlEnvironmentList' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DtlEnvironment' x-ms-examples: Environments_List: $ref: ./examples/Environments_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name} : get: tags: - Environments description: Get environment. operationId: microsoftAzureEnvironmentsGet parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labName in: path description: The name of the lab. required: true type: string - name: userName in: path description: The name of the user profile. required: true type: string - name: name in: path description: The name of the environment. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($select=deploymentProperties)''' type: string - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/DtlEnvironment' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: Environments_Get: $ref: ./examples/Environments_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name put: tags: - Environments description: Create or replace an existing environment. This operation can take a while to complete. operationId: microsoftAzureEnvironmentsCreateorupdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labName in: path description: The name of the lab. required: true type: string - name: userName in: path description: The name of the user profile. required: true type: string - name: name in: path description: The name of the environment. required: true type: string - name: dtlEnvironment in: body description: An environment, which is essentially an ARM template deployment. required: true schema: $ref: '#/definitions/DtlEnvironment' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/DtlEnvironment' '201': description: Created schema: $ref: '#/definitions/DtlEnvironment' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: Environments_CreateOrUpdate: $ref: ./examples/Environments_CreateOrUpdate.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name delete: tags: - Environments description: Delete environment. This operation can take a while to complete. operationId: microsoftAzureEnvironmentsDelete parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labName in: path description: The name of the lab. required: true type: string - name: userName in: path description: The name of the user profile. required: true type: string - name: name in: path description: The name of the environment. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: Environments_Delete: $ref: ./examples/Environments_Delete.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name patch: tags: - Environments description: Allows modifying tags of environments. All other properties will be ignored. operationId: microsoftAzureEnvironmentsUpdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labName in: path description: The name of the lab. required: true type: string - name: userName in: path description: The name of the user profile. required: true type: string - name: name in: path description: The name of the environment. required: true type: string - name: dtlEnvironment in: body description: An environment, which is essentially an ARM template deployment. required: true schema: $ref: '#/definitions/DtlEnvironmentFragment' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/DtlEnvironment' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: Environments_Update: $ref: ./examples/Environments_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments : get: tags: - Environments description: List environments in a given environment setting. operationId: microsoftAzureEnvironmentsList parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($expand=networkInterface)''' required: false type: string - name: $filter in: query description: The filter to apply to the operation. required: false type: string - name: $top in: query description: The maximum number of resources to return from the operation. required: false type: integer format: int32 - name: $orderby in: query description: The ordering expression for the results, using OData notation. required: false type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/ResponseWithContinuation[Environment]' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/Environment' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName} : get: tags: - Environments description: Get environment operationId: microsoftAzureEnvironmentsGet parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($expand=networkInterface)''' required: false type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/Environment_3' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname put: tags: - Environments description: Create or replace an existing Environment. operationId: microsoftAzureEnvironmentsCreateorupdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - name: environment in: body description: Represents an environment instance required: true schema: $ref: '#/definitions/Environment_3' - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/Environment_3' '201': description: Created schema: $ref: '#/definitions/Environment_3' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname delete: tags: - Environments description: Delete environment. This operation can take a while to complete operationId: microsoftAzureEnvironmentsDelete parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - $ref: '#/parameters/api-version_2' responses: '202': description: Accepted '204': description: No Content default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname patch: tags: - Environments description: Modify properties of environments. operationId: microsoftAzureEnvironmentsUpdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - name: environment in: body description: Represents an environment instance required: true schema: $ref: '#/definitions/EnvironmentFragment' - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/Environment_3' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/claim : post: tags: - Environments description: Claims the environment and assigns it to the user operationId: microsoftAzureEnvironmentsClaim parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname Claim ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/resetPassword : post: tags: - Environments description: Resets the user password on an environment This operation can take a while to complete operationId: microsoftAzureEnvironmentsResetpassword parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - name: resetPasswordPayload in: body description: Represents the payload for resetting passwords. required: true schema: $ref: '#/definitions/ResetPasswordPayload' - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname Resetpassword ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/start : post: tags: - Environments description: Starts an environment by starting all resources inside the environment. This operation can take a while to complete operationId: microsoftAzureEnvironmentsStart parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname Start ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/stop : post: tags: - Environments description: Stops an environment by stopping all resources inside the environment This operation can take a while to complete operationId: microsoftAzureEnvironmentsStop parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: labName in: path description: The name of the lab. required: true type: string - name: environmentSettingName in: path description: The name of the environment Setting. required: true type: string - name: environmentName in: path description: The name of the environment. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Environments Environmentname Stop ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName} : put: tags: - Environments operationId: microsoftAzureEnvironmentsCreateorupdate x-ms-examples: EnvironmentsCreate: $ref: ./examples/EnvironmentsCreate.json x-ms-long-running-operation: true description: Create or update an environment in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: environmentName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 description: Name of the environment - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/EnvironmentCreateOrUpdateParameters' description: Parameters for creating an environment resource. responses: '200': description: The existing environment definition was successfully updated. schema: $ref: '#/definitions/EnvironmentResource' '201': description: The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property. schema: $ref: '#/definitions/EnvironmentResource' '404': description: The subscription or resource group could not be found. default: description: 'HTTP 400 (Bad Request): The given environment request body is invalid; See the error code and message in the response for details.' schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname get: tags: - Environments operationId: microsoftAzureEnvironmentsGet x-ms-examples: EnvironmentsGet: $ref: ./examples/EnvironmentsGet.json description: Gets the environment with the specified name in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter_2' - $ref: '#/parameters/ExpandParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property. schema: $ref: '#/definitions/EnvironmentResource' default: description: 'HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.' schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname patch: tags: - Environments operationId: microsoftAzureEnvironmentsUpdate x-ms-examples: EnvironmentsUpdate: $ref: ./examples/EnvironmentsPatchTags.json x-ms-long-running-operation: true description: Updates the environment with the specified name in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter_2' - name: environmentUpdateParameters in: body required: true schema: $ref: '#/definitions/EnvironmentUpdateParameters' description: Request object that contains the updated information for the environment. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of "Succeeded". If the environment was updated asynchronously, the response will include a provisioningState value of "Updating". You can periodically get your environment definition and monitor progress of the update via the provisioningState property. schema: $ref: '#/definitions/EnvironmentResource' default: description: 'HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.' schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname delete: tags: - Environments operationId: microsoftAzureEnvironmentsDelete x-ms-examples: EnvironmentsDelete: $ref: ./examples/EnvironmentsDelete.json description: Deletes the environment with the specified name in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter_2' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The environment was successfully deleted. '204': description: The environment was successfully deleted. default: description: 'HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.' schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments: get: tags: - Environments operationId: microsoftAzureEnvironmentsListbyresourcegroup x-ms-examples: EnvironmentsByResourceGroup: $ref: ./examples/EnvironmentsListByResourceGroup.json description: Lists all the available environments associated with the subscription and within the specified resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Environments returned successfully. schema: $ref: '#/definitions/EnvironmentListResponse' default: description: 'HTTP 404 (Not Found): The subscription, or resource group could not be found.' schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments /subscriptions/{subscriptionId}/providers/Microsoft.TimeSeriesInsights/environments: get: tags: - Environments operationId: microsoftAzureEnvironmentsListbysubscription x-ms-examples: EnvironmentsBySubscription: $ref: ./examples/EnvironmentsListBySubscription.json description: Lists all the available environments within a subscription, irrespective of the resource groups. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Environments returned successfully. schema: $ref: '#/definitions/EnvironmentListResponse' default: description: 'HTTP 404 (Not Found): The subscription could not be found.' schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Timeseriesinsights Environments definitions: EnvironmentProperties: description: Properties of an environment. type: object properties: deploymentProperties: $ref: '#/definitions/EnvironmentDeploymentProperties' description: The deployment properties of the environment. armTemplateDisplayName: description: The display name of the Azure Resource Manager template that produced the environment. type: string resourceGroupId: description: The identifier of the resource group containing the environment's resources. type: string readOnly: true createdByUser: description: The creator of the environment. type: string readOnly: true provisioningState: description: The provisioning status of the resource. type: string readOnly: true uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string readOnly: true LatestOperationResult: description: Details of the status of an operation. type: object properties: status: description: The current status of the operation. type: string readOnly: true errorCode: description: Error code on failure. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true requestUri: description: Request URI of the operation. type: string readOnly: true httpMethod: description: The HttpMethod - PUT/POST/DELETE for the operation. type: string readOnly: true operationUrl: description: The URL to use to check long-running operation status type: string readOnly: true EnvironmentUpdateProperties: description: Properties of an environment. These properties can be updated after the resource has been created. type: object properties: parameters: type: object description: Parameters object for the environment. Sku: type: object properties: name: type: string description: The name of this SKU. enum: - S1 - S2 - P1 - L1 x-ms-enum: name: SkuName modelAsString: true capacity: format: int32 type: integer description: The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created. minimum: 1 maximum: 10 required: - name - capacity description: The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. Environment_3: description: Represents an environment instance type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/EnvironmentProperties_2' description: The properties of the Environment resource x-ms-client-flatten: true EnvironmentKind: type: string description: Environment kind enum: - development - testing - staging - production x-ms-enum: name: EnvironmentKind modelAsString: true values: - name: Development value: development description: Environment is in the development stage - name: Testing value: testing description: Environment is in the testing stage - name: Staging value: staging description: Environment is in the staging stage - name: Production value: production description: Environment is in the production stage CloudErrorBody: description: Body of an error from a REST request. type: object properties: code: description: The error code. type: string message: description: The error message. type: string target: description: The error target. type: string details: description: Inner errors. type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-external: true EnvironmentCreateOrUpdateParameters: discriminator: kind properties: kind: type: string description: The kind of the environment. enum: - Gen1 - Gen2 x-ms-enum: name: EnvironmentKind modelAsString: true x-ms-mutability: - create - read sku: $ref: '#/definitions/Sku' description: The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. required: - kind - sku allOf: - $ref: '#/definitions/CreateOrUpdateTrackedResourceProperties' description: Parameters supplied to the CreateOrUpdate Environment operation. EnvironmentOperationKind: type: string enum: - Deploy - Delete description: The type of environment operation. x-ms-enum: name: EnvironmentOperationKind modelAsString: true values: - value: Deploy description: The operation represents a deployment. - value: Delete description: The operation represents a delete. EnvironmentResource: type: object discriminator: kind properties: sku: $ref: '#/definitions/Sku' description: The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. kind: type: string description: The kind of the environment. enum: - Gen1 - Gen2 required: - kind - sku allOf: - $ref: '#/definitions/TrackedResource' description: An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. ResourceSetFragment: description: Represents a VM and the setting Id it was created for. type: object properties: vmResourceId: description: VM resource Id for the environment type: string resourceSettingId: description: resourceSettingId for the environment type: string Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message DtlEnvironmentList: description: The response of a list operation. type: object properties: value: description: Results of the list operation. type: array items: $ref: '#/definitions/DtlEnvironment' nextLink: description: Link for next set of results. type: string Environment: type: object description: Environment resource model. properties: name: type: string description: Environment identifier. maxLength: 50 title: type: string description: The name of the environment. maxLength: 50 kind: $ref: '#/definitions/EnvironmentKind' description: Kind of deployment environment. description: type: string description: Description of the environment. maxLength: 1000 server: $ref: '#/definitions/EnvironmentServer' description: Server information of the environment. onboarding: $ref: '#/definitions/EnvironmentOnboardingModel' description: Onboarding information for this environment. customProperties: type: object description: The custom metadata defined for environment entities. required: - name - title - kind EnvironmentDeploymentProperties: description: Properties of an environment deployment. type: object properties: armTemplateId: description: The Azure Resource Manager template's identifier. type: string parameters: description: The parameters of the Azure Resource Manager template. type: array items: $ref: '#/definitions/ArmTemplateParameterProperties' Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error Resource: description: An Azure resource. type: object properties: id: description: The identifier of the resource. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. type: string tags: description: The tags of the resource. type: object additionalProperties: type: string x-ms-azure-resource: true EnvironmentProperties_2: description: Properties of an environment type: object properties: resourceSets: $ref: '#/definitions/ResourceSet' description: The set of a VM and the setting id it was created for claimedByUserObjectId: description: The AAD object Id of the user who has claimed the environment type: string readOnly: true claimedByUserPrincipalId: description: The user principal Id of the user who has claimed the environment type: string readOnly: true claimedByUserName: description: The name or email address of the user who has claimed the environment type: string readOnly: true isClaimed: description: Is the environment claimed or not type: boolean readOnly: true lastKnownPowerState: description: Last known power state of the environment type: string readOnly: true networkInterface: $ref: '#/definitions/NetworkInterface' description: Network details of the environment readOnly: true totalUsage: format: duration description: How long the environment has been used by a lab user type: string readOnly: true passwordLastReset: format: date-time description: When the password was last reset on the environment. type: string readOnly: true provisioningState: description: The provisioning status of the resource. type: string uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string latestOperationResult: $ref: '#/definitions/LatestOperationResult' description: 'The details of the latest operation. ex: status, error' readOnly: true NetworkInterface: description: Network details of the environment type: object properties: privateIpAddress: description: PrivateIp address of the Compute VM type: string readOnly: true sshAuthority: description: Connection information for Linux type: string readOnly: true rdpAuthority: description: Connection information for Windows type: string readOnly: true username: description: Username of the VM type: string readOnly: true DtlEnvironment: description: An environment, which is essentially an ARM template deployment. required: - properties type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/EnvironmentProperties' description: The properties of the resource. x-ms-client-flatten: true ArmTemplateParameterProperties: description: Properties of an Azure Resource Manager template parameter. type: object properties: name: description: The name of the template parameter. type: string value: description: The value of the template parameter. type: string TrackedResource: properties: location: type: string description: Resource location x-ms-mutability: - read - create tags: type: object additionalProperties: type: string description: Resource tags allOf: - $ref: '#/definitions/Resource_2' required: - location description: Time Series Insights resource that is tracked by Azure Resource Manager. EnvironmentFragment: description: Represents an environment instance type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/EnvironmentPropertiesFragment' description: The properties of the Environment resource x-ms-client-flatten: true ResponseWithContinuation[Environment]: description: The response of a list operation. type: object properties: value: description: Results of the list operation. type: array items: $ref: '#/definitions/Environment_3' nextLink: description: Link for next set of results. type: string EnvironmentOperationListResult: type: object description: The action results list result. properties: value: description: The current page of results. type: array items: $ref: '#/definitions/EnvironmentOperation' nextLink: type: string description: The URL to get the next set of results. required: - value EnvironmentListResponse: properties: value: type: array items: $ref: '#/definitions/EnvironmentResource' description: Result of the List Environments operation. description: The response of the List Environments operation. EnvironmentOperationStatus: type: string enum: - NotStarted - Running - Succeeded - Canceled - Failed description: The status of an environment operation. x-ms-enum: name: EnvironmentOperationStatus modelAsString: true values: - value: NotStarted description: The operation has not started. - value: Running description: The operation is running. - value: Succeeded description: The operation succeeded. - value: Canceled description: The operation was canceled. - value: Failed description: The operation failed. EnvironmentOperation: type: object description: Information about an operation on an environment. discriminator: kind properties: uri: description: The unique URI for the environment operation. type: string operationId: description: Unique identifier for the environment operation. type: string kind: description: The kind of operation that occurred. $ref: '#/definitions/EnvironmentOperationKind' status: description: The operation status. $ref: '#/definitions/EnvironmentOperationStatus' createdByObjectId: description: The object ID of the actor which initiated the operation. type: string startTime: description: The time the operation started. type: string format: date-time endTime: description: The time the operation finished. type: string format: date-time environmentParameters: type: object description: Parameters object for the environment at the time of the operation. error: description: Provisioning or operation error details. Populated only for error states. $ref: devcenter.json#/definitions/CloudErrorBody required: - uri - operationId - kind - status DtlEnvironmentFragment: description: An environment, which is essentially an ARM template deployment. type: object allOf: - $ref: '#/definitions/UpdateResource' properties: {} ResetPasswordPayload: description: Represents the payload for resetting passwords. required: - environmentId type: object properties: environmentId: description: The resourceId of the environment type: string username: description: The username for which the password will be reset. type: string password: description: The password to assign to the user specified in type: string EnvironmentOnboardingModel: type: object description: Environment Onboarding Model properties: instructions: type: string description: Instructions how to onboard to the environment. maxLength: 1000 developerPortalUris: type: array description: Developer portal URIs of the environment. items: type: string format: uri required: - instructions - developerPortalUris CloudError_3: type: object properties: error: $ref: '#/definitions/CloudErrorBody_3' description: Describes a particular API error with an error code and a message. description: Contains information about an API error. x-ms-external: true ResourceSet: description: Represents a VM and the setting Id it was created for. type: object properties: vmResourceId: description: VM resource Id for the environment type: string resourceSettingId: description: resourceSettingId for the environment type: string Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. CloudErrorBody_2: description: Body of an error from a REST request. type: object properties: code: type: string message: type: string target: type: string details: description: Inner errors. type: array items: $ref: '#/definitions/CloudErrorBody_2' x-ms-external: true EnvironmentListResult: description: Results of the environment list operation. type: object properties: value: description: Current page of results. type: array items: $ref: '#/definitions/Environment_2' nextLink: description: URL to get the next set of results if there are any. type: string required: - value EnvironmentUpdateParameters: type: object discriminator: kind properties: kind: type: string description: The kind of the environment. enum: - Gen1 - Gen2 x-ms-enum: name: EnvironmentKind modelAsString: true tags: type: object additionalProperties: type: string description: Key-value pairs of additional properties for the environment. required: - kind description: Parameters supplied to the Update Environment operation. PagedEnvironmentAll: type: object description: Paged collection of Environment items across workspaces properties: value: type: array description: The Environment items on this page items: $ref: '#/definitions/Environment' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value CloudErrorBody_3: type: object description: Describes a particular API error with an error code and a message. properties: code: type: string description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. message: type: string description: A message that describes the error in detail and provides debugging information. 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_3' description: Describes a particular API error with an error code and a message. x-ms-identifiers: [] description: Contains nested errors that are related to this error. x-ms-external: true Resource_2: properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type description: Time Series Insights resource x-ms-azure-resource: true CreateOrUpdateTrackedResourceProperties: properties: location: type: string description: The location of the resource. x-ms-mutability: - read - create tags: type: object additionalProperties: type: string description: Key-value pairs of additional properties for the resource. required: - location description: Properties required to create any resource tracked by Azure Resource Manager. EnvironmentServer: type: object description: Environment Server properties: type: type: string description: Type of the server that represents the environment. managementPortalUris: type: array description: URIs of the server's management portal. items: type: string format: uri required: - type - managementPortalUris CloudError: description: Error from a REST request. type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: The cloud error that occurred x-ms-external: true EnvironmentPropertiesFragment: description: Properties of an environment type: object properties: resourceSets: $ref: '#/definitions/ResourceSetFragment' description: The set of a VM and the setting id it was created for provisioningState: description: The provisioning status of the resource. type: string uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string UpdateResource: description: Represents an update resource type: object properties: tags: description: The tags of the resource. type: object additionalProperties: type: string Environment_2: description: Properties of an environment. type: object allOf: - $ref: '#/definitions/EnvironmentUpdateProperties' properties: uri: description: The unique URI of the environment type: string readOnly: true name: type: string description: Environment name. readOnly: true environmentType: type: string description: Environment type. x-ms-mutability: - read - create user: type: string description: The AAD object id of the owner of this Environment. readOnly: true provisioningState: description: The provisioning state of the environment. type: string readOnly: true resourceGroupId: description: The identifier of the resource group containing the environment's resources. type: string readOnly: true catalogName: type: string description: Name of the catalog. x-ms-mutability: - read - create environmentDefinitionName: type: string description: Name of the environment definition. x-ms-mutability: - read - create error: description: Provisioning error details. Populated only for error states. readOnly: true $ref: devcenter.json#/definitions/CloudErrorBody required: - environmentType - catalogName - environmentDefinitionName CloudError_2: description: Error from a REST request. type: object properties: error: $ref: '#/definitions/CloudErrorBody_2' x-ms-external: true parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. Azure.Core.TopQueryParameter: name: top in: query description: The number of result items to return. required: false type: integer format: int32 x-ms-parameter-location: method resourceGroupName: name: resourceGroupName in: path description: The name of the resource group. required: true type: string x-ms-parameter-location: method ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string x-ms-parameter-location: method description: Name of an Azure Resource group. api-version: name: api-version in: query description: Client API version. required: true type: string default: '2018-09-15' EnvironmentOperationIdParameter: name: operationId in: path required: true type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ minLength: 3 maxLength: 63 description: The id of the operation on an environment. x-ms-parameter-location: method EnvironmentNameParameter_2: name: environmentName in: path required: true type: string description: The name of the Time Series Insights environment associated with the specified resource group. x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path description: Azure Subscription ID. required: true type: string subscriptionId: name: subscriptionId in: path description: The subscription ID. required: true type: string ExpandParameter: name: $expand in: query required: false type: string x-ms-parameter-location: method description: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service. Azure.Core.MaxPageSizeQueryParameter: name: maxpagesize in: query description: The maximum number of result items per page. required: false type: integer format: int32 x-ms-parameter-location: method Azure.Core.SkipQueryParameter: name: skip in: query description: The number of result items to skip. required: false type: integer format: int32 default: 0 x-ms-parameter-location: method 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 api-version_2: name: api-version in: query description: Client API version. required: true type: string default: '2018-10-15' Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'