您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Environments - Create Or Update

创建或替换现有环境。 此操作可能需要一段时间才能完成。

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

URI 参数

Name In Required Type Description
labName
path True
  • string

实验室的名称。

name
path True
  • string

环境的名称。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

订阅的 ID。

userName
path True
  • string

用户配置文件的名称。

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Type Description
location
  • string

资源的位置。

properties.armTemplateDisplayName
  • string

生成环境的 Azure 资源管理器模板的显示名称。

properties.deploymentProperties

环境的部署属性。

tags
  • object

资源的标记。

响应

Name Type Description
200 OK

确定

201 Created

创建

Other Status Codes

BadRequest

安全性

azure_auth

OAuth2 隐式授权

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 访问 Microsoft Azure

示例

Environments_CreateOrUpdate

Sample Request

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/@me/environments/{environmentName}?api-version=2018-09-15
{
  "properties": {
    "deploymentProperties": {
      "parameters": [],
      "armTemplateId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "location": "{location}",
  "properties": {
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "createdByUser": "user@contoso.com",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}
{
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "location": "{location}",
  "properties": {
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "createdByUser": "user@contoso.com",
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

定义

ArmTemplateParameterProperties

Azure 资源管理器模板参数的属性。

CloudError

REST 请求出错。

CloudErrorBody

来自 REST 请求的错误正文。

DtlEnvironment

环境,它实质上是 ARM 模板部署。

EnvironmentDeploymentProperties

环境部署的属性。

ArmTemplateParameterProperties

Azure 资源管理器模板参数的属性。

Name Type Description
name
  • string

模板参数的名称。

value
  • string

模板参数的值。

CloudError

REST 请求出错。

Name Type Description
error

发生的云错误

CloudErrorBody

来自 REST 请求的错误正文。

Name Type Description
code
  • string

错误代码。

details

内部错误。

message
  • string

错误消息。

target
  • string

错误目标。

DtlEnvironment

环境,它实质上是 ARM 模板部署。

Name Type Description
id
  • string

资源的标识符。

location
  • string

资源的位置。

name
  • string

资源的名称。

properties.armTemplateDisplayName
  • string

生成环境的 Azure 资源管理器模板的显示名称。

properties.createdByUser
  • string

环境的创建者。

properties.deploymentProperties

环境的部署属性。

properties.provisioningState
  • string

资源的设置状态。

properties.resourceGroupId
  • string

包含环境资源的资源组的标识符。

properties.uniqueIdentifier
  • string

资源 (Guid) 的唯一不可变标识符。

tags
  • object

资源的标记。

type
  • string

资源类型。

EnvironmentDeploymentProperties

环境部署的属性。

Name Type Description
armTemplateId
  • string

Azure 资源管理器模板的标识符。

parameters

Azure 资源管理器模板的参数。