Environments - Create Or Update

Servicio:: Dev Test Labs

Versión de la API:: 2018-09-15

Cree o reemplace un entorno existente. Esta operación puede tardar un tiempo en completarse.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
labName	path	True	string	Nombre del laboratorio.
name	path	True	string	Nombre del entorno.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
userName	path	True	string	Nombre del perfil de usuario.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
location	string	Ubicación geográfica donde reside el recurso
properties.armTemplateDisplayName	string	Nombre para mostrar de la plantilla de Azure Resource Manager que generó el entorno.
properties.deploymentProperties	EnvironmentDeploymentProperties	Las propiedades de implementación del entorno.
tags	object	Etiquetas de recursos.

Respuestas

Nombre

Tipo

Description

200 OK

La operación de actualización del recurso "DtlEnvironment" se realizó correctamente

201 Created

La operación de creación del recurso "DtlEnvironment" se realizó correctamente

Encabezados

Location: string
Retry-After: integer

Other Status Codes

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Environments_CreateOrUpdate

Solicitud de ejemplo

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": []
    }
  }
}

Respuesta de muestra

status code:: 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"
  }
}

status code:: 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"
  }
}

Definiciones

Nombre	Description
ArmTemplateParameterProperties	Propiedades de un parámetro de plantilla de Azure Resource Manager.
createdByType	Tipo de identidad que creó el recurso.
DtlEnvironment	Un entorno, que es básicamente una implementación de plantillas de ARM.
EnvironmentDeploymentProperties	Propiedades de una implementación de entorno.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
systemData	Metadatos relativos a la creación y última modificación del recurso.

ArmTemplateParameterProperties

Objeto

Propiedades de un parámetro de plantilla de Azure Resource Manager.

Nombre	Tipo	Description
name	string	Nombre del parámetro de plantilla.
value	string	Valor del parámetro de plantilla.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DtlEnvironment

Objeto

Un entorno, que es básicamente una implementación de plantillas de ARM.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Ej: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.armTemplateDisplayName	string	Nombre para mostrar de la plantilla de Azure Resource Manager que generó el entorno.
properties.createdByUser	string	El creador del entorno.
properties.deploymentProperties	EnvironmentDeploymentProperties	Las propiedades de implementación del entorno.
properties.provisioningState	string	Estado de aprovisionamiento del recurso.
properties.resourceGroupId	string	Identificador del grupo de recursos que contiene los recursos del entorno.
properties.uniqueIdentifier	string	Identificador inmutable único de un recurso (Guid).
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Objeto

Propiedades de una implementación de entorno.

Nombre	Tipo	Description
armTemplateId	string	Identificador de la plantilla de Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Parámetros de la plantilla de Azure Resource Manager.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.