你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Environments - Get
获取环境。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}?$expand={$expand}&api-version=2018-09-15
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
lab
|
path | True |
string |
实验室的名称。 |
name
|
path | True |
string |
环境的名称。 |
resource
|
path | True |
string |
资源组的名称。 |
subscription
|
path | True |
string |
订阅的 ID。 |
user
|
path | True |
string |
用户配置文件的名称。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
$expand
|
query |
string |
指定$expand查询。 示例:“properties ($select=deploymentProperties) ” |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
BadRequest |
安全性
azure_auth
OAuth2 隐式授权
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 访问 Microsoft Azure |
示例
Environments_Get
Sample Request
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"
}
}
定义
名称 | 说明 |
---|---|
Arm |
Azure 资源管理器模板参数的属性。 |
Cloud |
REST 请求出错。 |
Cloud |
REST 请求的错误正文。 |
Dtl |
环境,实质上是 ARM 模板部署。 |
Environment |
环境部署的属性。 |
ArmTemplateParameterProperties
Azure 资源管理器模板参数的属性。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
模板参数的名称。 |
value |
string |
模板参数的值。 |
CloudError
REST 请求出错。
名称 | 类型 | 说明 |
---|---|---|
error |
发生的云错误 |
CloudErrorBody
REST 请求的错误正文。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
内部错误。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
DtlEnvironment
环境,实质上是 ARM 模板部署。
名称 | 类型 | 说明 |
---|---|---|
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
环境部署的属性。
名称 | 类型 | 说明 |
---|---|---|
armTemplateId |
string |
Azure 资源管理器模板的标识符。 |
parameters |
Azure 资源管理器模板的参数。 |