Environments - List
List environments in a given user profile.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
|
The subscription ID. |
resource
|
path | True |
|
The name of the resource group. |
lab
|
path | True |
|
The name of the lab. |
user
|
path | True |
|
The name of the user profile. |
$expand
|
query |
|
Specify the $expand query. Example: 'properties($select=deploymentProperties)' |
|
$filter
|
query |
|
The filter to apply to the operation. Example: '$filter=contains(name,'myName') |
|
$top
|
query |
|
The maximum number of resources to return from the operation. Example: '$top=10' |
|
$orderby
|
query |
|
The ordering expression for the results, using OData notation. Example: '$orderby=name desc' |
|
api-version
|
query | True |
|
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
Security
azure_auth
OAuth2 Implicit Grant
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Access Microsoft Azure |
Definitions
Arm |
Properties of an Azure Resource Manager template parameter. |
Cloud |
Error from a REST request. |
Cloud |
Body of an error from a REST request. |
Dtl |
An environment, which is essentially an ARM template deployment. |
Dtl |
The response of a list operation. |
Environment |
Properties of an environment deployment. |
ArmTemplateParameterProperties
Properties of an Azure Resource Manager template parameter.
Name | Type | Description |
---|---|---|
name |
|
The name of the template parameter. |
value |
|
The value of the template parameter. |
CloudError
Error from a REST request.
Name | Type | Description |
---|---|---|
error |
The cloud error that occurred |
CloudErrorBody
Body of an error from a REST request.
Name | Type | Description |
---|---|---|
code |
|
The error code. |
details |
Inner errors. |
|
message |
|
The error message. |
target |
|
The error target. |
DtlEnvironment
An environment, which is essentially an ARM template deployment.
Name | Type | Description |
---|---|---|
id |
|
The identifier of the resource. |
location |
|
The location of the resource. |
name |
|
The name of the resource. |
properties.armTemplateDisplayName |
|
The display name of the Azure Resource Manager template that produced the environment. |
properties.createdByUser |
|
The creator of the environment. |
properties.deploymentProperties |
The deployment properties of the environment. |
|
properties.provisioningState |
|
The provisioning status of the resource. |
properties.resourceGroupId |
|
The identifier of the resource group containing the environment's resources. |
properties.uniqueIdentifier |
|
The unique immutable identifier of a resource (Guid). |
tags |
|
The tags of the resource. |
type |
|
The type of the resource. |
DtlEnvironmentList
The response of a list operation.
Name | Type | Description |
---|---|---|
nextLink |
|
Link for next set of results. |
value |
Results of the list operation. |
EnvironmentDeploymentProperties
Properties of an environment deployment.
Name | Type | Description |
---|---|---|
armTemplateId |
|
The Azure Resource Manager template's identifier. |
parameters |
The parameters of the Azure Resource Manager template. |