Environments - Create Or Update

Serviço:: Dev Test Labs

Versão API:: 2018-09-15

Crie ou substitua um ambiente existente. Esta operação pode demorar algum tempo a concluir.

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 URI

Nome	Em	Necessário	Tipo	Descrição
labName	path	True	string	O nome do laboratório.
name	path	True	string	O nome do ambiente.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
userName	path	True	string	O nome do perfil de usuário.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Órgão do Pedido

Nome	Tipo	Descrição
location	string	A geolocalização onde o recurso vive
properties.armTemplateDisplayName	string	O nome para exibição do modelo do Azure Resource Manager que produziu o ambiente.
properties.deploymentProperties	EnvironmentDeploymentProperties	As propriedades de implantação do ambiente.
tags	object	Tags de recursos.

Respostas

Nome	Tipo	Descrição
200 OK	DtlEnvironment	Operação de atualização de recurso 'DtlEnvironment' bem-sucedida
201 Created	DtlEnvironment	Recurso 'DtlEnvironment' criar operação bem-sucedida Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Descrição

200 OK

DtlEnvironment

Operação de atualização de recurso 'DtlEnvironment' bem-sucedida

201 Created

DtlEnvironment

Recurso 'DtlEnvironment' criar operação bem-sucedida

Cabeçalhos

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Environments_CreateOrUpdate

Pedido de exemplo

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

Resposta de exemplo

Código de estado:: 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"
  }
}

Código de estado:: 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"
  }
}

Definições

Nome	Descrição
ArmTemplateParameterProperties	Propriedades de um parâmetro de modelo do Azure Resource Manager.
createdByType	O tipo de identidade que criou o recurso.
DtlEnvironment	Um ambiente, que é essencialmente uma implantação de modelo ARM.
EnvironmentDeploymentProperties	Propriedades de uma implantação de ambiente.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados referentes à criação e última modificação do recurso.

ArmTemplateParameterProperties

Objetivo

Propriedades de um parâmetro de modelo do Azure Resource Manager.

Nome	Tipo	Descrição
name	string	O nome do parâmetro template.
value	string	O valor do parâmetro template.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DtlEnvironment

Objetivo

Um ambiente, que é essencialmente uma implantação de modelo ARM.

Nome	Tipo	Descrição
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.armTemplateDisplayName	string	O nome para exibição do modelo do Azure Resource Manager que produziu o ambiente.
properties.createdByUser	string	O criador do ambiente.
properties.deploymentProperties	EnvironmentDeploymentProperties	As propriedades de implantação do ambiente.
properties.provisioningState	string	O status de provisionamento do recurso.
properties.resourceGroupId	string	O identificador do grupo de recursos que contém os recursos do ambiente.
properties.uniqueIdentifier	string	O identificador único imutável de um recurso (Guid).
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Objetivo

Propriedades de uma implantação de ambiente.

Nome	Tipo	Descrição
armTemplateId	string	O identificador do modelo do Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Os parâmetros do modelo do Azure Resource Manager.

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

Nome	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Environments - Create Or Update

Parâmetros URI

Órgão do Pedido

Respostas

Segurança

azure_auth

Alcances

Exemplos

Environments_CreateOrUpdate

Pedido de exemplo

Resposta de exemplo

Definições

ArmTemplateParameterProperties

createdByType

DtlEnvironment

EnvironmentDeploymentProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData