Environments - Create Or Update

Servizio:

Dev Test Labs

Versione API:

2018-09-15

Creare o sostituire un ambiente esistente. Il completamento di questa operazione può richiedere alcuni minuti.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
labName	path	True	string	Nome del lab.
name	path	True	string	Il nome dell'ambiente.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
userName	path	True	string	Nome del profilo utente.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
location	string	Posizione geografica in cui risiede la risorsa
properties.armTemplateDisplayName	string	Nome visualizzato del modello di Azure Resource Manager che ha prodotto l'ambiente.
properties.deploymentProperties	EnvironmentDeploymentProperties	Proprietà di distribuzione dell'ambiente.
tags	object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	DtlEnvironment	L'operazione di aggiornamento della risorsa 'DtlEnvironment' è riuscita
201 Created	DtlEnvironment	L'operazione di creazione della risorsa 'DtlEnvironment' è riuscita Intestazioni Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Environments_CreateOrUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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"
  }
}

Codice di stato:

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"
  }
}

Definizioni

Nome	Descrizione
ArmTemplateParameterProperties	Proprietà di un parametro di modello di Azure Resource Manager.
createdByType	Tipo di identità che ha creato la risorsa.
DtlEnvironment	Un ambiente, che è essenzialmente una distribuzione di modelli di Resource Manager.
EnvironmentDeploymentProperties	Proprietà di una distribuzione dell'ambiente.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ArmTemplateParameterProperties

Oggetto

Proprietà di un parametro di modello di Azure Resource Manager.

Nome	Tipo	Descrizione
name	string	Nome del parametro del modello.
value	string	Valore del parametro del modello.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DtlEnvironment

Oggetto

Un ambiente, che è essenzialmente una distribuzione di modelli di Resource Manager.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.armTemplateDisplayName	string	Nome visualizzato del modello di Azure Resource Manager che ha prodotto l'ambiente.
properties.createdByUser	string	L'autore dell'ambiente.
properties.deploymentProperties	EnvironmentDeploymentProperties	Proprietà di distribuzione dell'ambiente.
properties.provisioningState	string	Stato del provisioning della risorsa.
properties.resourceGroupId	string	Identificatore del gruppo di risorse contenente le risorse dell'ambiente.
properties.uniqueIdentifier	string	Identificatore univoco non modificabile di una risorsa (GUID).
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Oggetto

Proprietà di una distribuzione dell'ambiente.

Nome	Tipo	Descrizione
armTemplateId	string	Identificatore del modello di Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Parametri del modello di Azure Resource Manager.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.