How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Environments API

The Environments API from Microsoft Azure — 18 operation(s) for environments.

Microsoft Azure Environments API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 29 operations across 18 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

29 operations 18 paths 47 schemas 4 DELETE14 GET3 PATCH4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 29

Across 18 paths, the API surfaces 29 operations — 4 DELETE, 14 GET, 3 PATCH, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Environments 29
GET
/environments
Microsoft Azure Get Environments
microsoftAzureEnvironmentsListall 4 params → 200default
GET
/projects/{projectName}/environments
Microsoft Azure Get Projects Projectname Environments
microsoftAzureEnvironmentsListenvironments 3 params → 200default
GET
/projects/{projectName}/users/{userId}/environments
Microsoft Azure Get Projects Projectname Users Userid Environments
microsoftAzureEnvironmentsListenvironmentsbyuser 4 params → 200default
GET
/projects/{projectName}/users/{userId}/environments/{environmentName}
Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname
microsoftAzureEnvironmentsGetenvironmentbyuser 4 params → 200default
PUT
/projects/{projectName}/users/{userId}/environments/{environmentName}
Microsoft Azure Put Projects Projectname Users Userid Environments Environmentname
microsoftAzureEnvironmentsCreateorreplaceenvironment 4 params body → 201default
DELETE
/projects/{projectName}/users/{userId}/environments/{environmentName}
Microsoft Azure Delete Projects Projectname Users Userid Environments Environmentname
microsoftAzureEnvironmentsDeleteenvironment 4 params → 202204default
GET
/projects/{projectName}/users/{userId}/environments/{environmentName}/operations
Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations
microsoftAzureEnvironmentsListoperations 6 params → 200default
GET
/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}
Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations Operationid
microsoftAzureEnvironmentsGetoperation 5 params → 200default
GET
/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs
Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations Operationid Logs
microsoftAzureEnvironmentsGetlogsbyoperation 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments
microsoftAzureEnvironmentsList 9 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name
microsoftAzureEnvironmentsGet 7 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name
microsoftAzureEnvironmentsCreateorupdate 6 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name
microsoftAzureEnvironmentsDelete 6 params → 200202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Username Environments Name
microsoftAzureEnvironmentsUpdate 6 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname En…
microsoftAzureEnvironmentsList 10 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname En…
microsoftAzureEnvironmentsGet 8 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname En…
microsoftAzureEnvironmentsCreateorupdate 7 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname…
microsoftAzureEnvironmentsDelete 7 params → 202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname…
microsoftAzureEnvironmentsUpdate 7 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/claim
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname E…
microsoftAzureEnvironmentsClaim 7 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/resetPassword
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname E…
microsoftAzureEnvironmentsResetpassword 7 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/start
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname E…
microsoftAzureEnvironmentsStart 7 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/stop
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname E…
microsoftAzureEnvironmentsStop 7 params → 200202default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname
microsoftAzureEnvironmentsCreateorupdate 4 params body → 200201404default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname
microsoftAzureEnvironmentsGet 5 params → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname
microsoftAzureEnvironmentsUpdate 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname
microsoftAzureEnvironmentsDelete 4 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments
microsoftAzureEnvironmentsListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.TimeSeriesInsights/environments
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Timeseriesinsights Environments
microsoftAzureEnvironmentsListbysubscription 2 params → 200default

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are EnvironmentProperties_2 (12 properties), EnvironmentOperation (9 properties), Environment_2 (9 properties), Environment (7 properties). Each schema is shown below with its type and property counts.

ArmTemplateParameterProperties
object
Properties of an Azure Resource Manager template parameter.
2 properties
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
ResetPasswordPayload
object
Represents the payload for resetting passwords.
3 properties 1 required
CloudError_2
object
Error from a REST request.
1 property
EnvironmentProperties
object
Properties of an environment.
6 properties
ResponseWithContinuation_Environment
object
The response of a list operation.
2 properties
Resource_2
object
Time Series Insights resource
3 properties
EnvironmentOperation
object
Information about an operation on an environment.
9 properties 4 required
EnvironmentDeploymentProperties
object
Properties of an environment deployment.
2 properties
EnvironmentPropertiesFragment
object
Properties of an environment
3 properties
PagedEnvironmentAll
object
Paged collection of Environment items across workspaces
2 properties 1 required
EnvironmentCreateOrUpdateParameters
object
Parameters supplied to the CreateOrUpdate Environment operation.
2 properties 2 required
EnvironmentListResponse
object
The response of the List Environments operation.
1 property
CreateOrUpdateTrackedResourceProperties
object
Properties required to create any resource tracked by Azure Resource Manager.
2 properties 1 required
CloudErrorBody_2
object
Body of an error from a REST request.
4 properties
CloudErrorBody_3
object
Describes a particular API error with an error code and a message.
4 properties
EnvironmentFragment
object
Represents an environment instance
1 property
EnvironmentOperationKind
string
The type of environment operation.
NetworkInterface
object
Network details of the environment
4 properties
EnvironmentResource
object
An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.
2 properties 2 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
Resource
object
An Azure resource.
5 properties
UpdateResource
object
Represents an update resource
1 property
ResourceSetFragment
object
Represents a VM and the setting Id it was created for.
2 properties
ResourceSet
object
Represents a VM and the setting Id it was created for.
2 properties
Environment_2
object
Properties of an environment.
9 properties 3 required
Environment_3
object
Represents an environment instance
1 property
EnvironmentProperties_2
object
Properties of an environment
12 properties
DtlEnvironmentList
object
The response of a list operation.
2 properties
DtlEnvironmentFragment
object
An environment, which is essentially an ARM template deployment.
Sku
object
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…
2 properties 2 required
EnvironmentOperationListResult
object
The action results list result.
2 properties 1 required
EnvironmentOnboardingModel
object
Environment Onboarding Model
2 properties 2 required
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
CloudErrorBody
object
Body of an error from a REST request.
4 properties
EnvironmentUpdateParameters
object
Parameters supplied to the Update Environment operation.
2 properties 1 required
EnvironmentServer
object
Environment Server
2 properties 2 required
EnvironmentUpdateProperties
object
Properties of an environment. These properties can be updated after the resource has been created.
1 property
CloudError
object
Error from a REST request.
1 property
CloudError_3
object
Contains information about an API error.
1 property
TrackedResource
object
Time Series Insights resource that is tracked by Azure Resource Manager.
2 properties 1 required
EnvironmentListResult
object
Results of the environment list operation.
2 properties 1 required
Environment
object
Environment resource model.
7 properties 3 required
EnvironmentOperationStatus
string
The status of an environment operation.
EnvironmentKind
string
Environment kind
DtlEnvironment
object
An environment, which is essentially an ARM template deployment.
1 property 1 required
LatestOperationResult
object
Details of the status of an operation.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-environments-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Environments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.