Environments - Update

Allows modifying tags of environments. All other properties will be ignored.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}?api-version=2018-09-15

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID.

resourceGroupName
path True
  • string

The name of the resource group.

labName
path True
  • string

The name of the lab.

userName
path True
  • string

The name of the user profile.

name
path True
  • string

The name of the environment.

api-version
query True
  • string

Client API version.

Request Body

Name Type Description
properties.armTemplateDisplayName
  • string

The display name of the Azure Resource Manager template that produced the environment.

properties.deploymentProperties

The deployment properties of the environment.

tags
  • object

The tags of the resource.

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

ArmTemplateParameterProperties

Properties of an Azure Resource Manager template parameter.

ArmTemplateParameterPropertiesFragment

Properties of an Azure Resource Manager template parameter.

CloudError

Error from a REST request.

CloudErrorBody

Body of an error from a REST request.

DtlEnvironment

An environment, which is essentially an ARM template deployment.

DtlEnvironmentFragment

An environment, which is essentially an ARM template deployment.

EnvironmentDeploymentProperties

Properties of an environment deployment.

EnvironmentDeploymentPropertiesFragment

Properties of an environment deployment.

ArmTemplateParameterProperties

Properties of an Azure Resource Manager template parameter.

Name Type Description
name
  • string

The name of the template parameter.

value
  • string

The value of the template parameter.

ArmTemplateParameterPropertiesFragment

Properties of an Azure Resource Manager template parameter.

Name Type Description
name
  • string

The name of the template parameter.

value
  • string

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
  • string

The error code.

details

Inner errors.

message
  • string

The error message.

target
  • string

The error target.

DtlEnvironment

An environment, which is essentially an ARM template deployment.

Name Type Description
id
  • string

The identifier of the resource.

location
  • string

The location of the resource.

name
  • string

The name of the resource.

properties.armTemplateDisplayName
  • string

The display name of the Azure Resource Manager template that produced the environment.

properties.createdByUser
  • string

The creator of the environment.

properties.deploymentProperties

The deployment properties of the environment.

properties.provisioningState
  • string

The provisioning status of the resource.

properties.resourceGroupId
  • string

The identifier of the resource group containing the environment's resources.

properties.uniqueIdentifier
  • string

The unique immutable identifier of a resource (Guid).

tags
  • object

The tags of the resource.

type
  • string

The type of the resource.

DtlEnvironmentFragment

An environment, which is essentially an ARM template deployment.

Name Type Description
properties.armTemplateDisplayName
  • string

The display name of the Azure Resource Manager template that produced the environment.

properties.deploymentProperties

The deployment properties of the environment.

tags
  • object

The tags of the resource.

EnvironmentDeploymentProperties

Properties of an environment deployment.

Name Type Description
armTemplateId
  • string

The Azure Resource Manager template's identifier.

parameters

The parameters of the Azure Resource Manager template.

EnvironmentDeploymentPropertiesFragment

Properties of an environment deployment.

Name Type Description
armTemplateId
  • string

The Azure Resource Manager template's identifier.

parameters

The parameters of the Azure Resource Manager template.