Environments - Create Or Update

Служба:: Dev Test Labs

Версия API:: 2018-09-15

Создайте или замените существующую среду. Эта операция может занять некоторое время.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
labName	path	True	string	Имя лаборатории.
name	path	True	string	Имя среды.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
userName	path	True	string	Имя профиля пользователя.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
location	string	Географическое расположение, в котором находится ресурс
properties.armTemplateDisplayName	string	Отображаемое имя шаблона Azure Resource Manager, создающего среду.
properties.deploymentProperties	EnvironmentDeploymentProperties	Свойства развертывания среды.
tags	object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	DtlEnvironment	Операция обновления ресурса 'DtlEnvironment' выполнена успешно
201 Created	DtlEnvironment	Операция по созданию ресурса 'DtlEnvironment' выполнена успешно Заголовки Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

DtlEnvironment

Операция обновления ресурса 'DtlEnvironment' выполнена успешно

201 Created

DtlEnvironment

Операция по созданию ресурса 'DtlEnvironment' выполнена успешно

Заголовки

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Environments_CreateOrUpdate

Образец запроса

HTTP

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": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}",
      "parameters": []
    }
  }
}

Пример ответа

Код состояния:: 200

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

Код состояния:: 201

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

Определения

Имя	Описание
ArmTemplateParameterProperties	Свойства параметра шаблона Azure Resource Manager.
createdByType	Тип удостоверения, создавшего ресурс.
DtlEnvironment	Среда, которая, по сути, является развертыванием шаблона ARM.
EnvironmentDeploymentProperties	Свойства развертывания среды.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

ArmTemplateParameterProperties

Объект

Свойства параметра шаблона Azure Resource Manager.

Имя	Тип	Описание
name	string	Имя параметра шаблона.
value	string	Значение параметра шаблона.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DtlEnvironment

Объект

Среда, которая, по сути, является развертыванием шаблона ARM.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.armTemplateDisplayName	string	Отображаемое имя шаблона Azure Resource Manager, создающего среду.
properties.createdByUser	string	Создатель среды.
properties.deploymentProperties	EnvironmentDeploymentProperties	Свойства развертывания среды.
properties.provisioningState	string	Состояние подготовки ресурса.
properties.resourceGroupId	string	Идентификатор группы ресурсов, содержащей ресурсы среды.
properties.uniqueIdentifier	string	Уникальный неизменяемый идентификатор ресурса (GUID).
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Объект

Свойства развертывания среды.

Имя	Тип	Описание
armTemplateId	string	Идентификатор шаблона Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Параметры шаблона Azure Resource Manager.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Environments - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Environments_CreateOrUpdate

Образец запроса

Пример ответа

Определения

ArmTemplateParameterProperties

createdByType

DtlEnvironment

EnvironmentDeploymentProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData