Environments - Create Or Update

Dienst:

Dev Test Labs

API-Version:

2018-09-15

Erstellen oder Ersetzen einer vorhandenen Umgebung. Dieser Vorgang kann eine Weile dauern.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labors.
name	path	True	string	Der Name der Umgebung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
userName	path	True	string	Der Name des Benutzerprofils.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
location	string	Der geografische Standort, an dem sich die Ressource befindet
properties.armTemplateDisplayName	string	Der Anzeigename der Azure Resource Manager-Vorlage, die die Umgebung erstellt hat.
properties.deploymentProperties	EnvironmentDeploymentProperties	Die Bereitstellungseigenschaften der Umgebung.
tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	DtlEnvironment	Der Aktualisierungsvorgang "DtlEnvironment" der Ressource war erfolgreich
201 Created	DtlEnvironment	Der Erstellungsvorgang der Ressource 'DtlEnvironment' war erfolgreich Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Environments_CreateOrUpdate

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
ArmTemplateParameterProperties	Eigenschaften eines Azure Resource Manager-Vorlagenparameters.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DtlEnvironment	Eine Umgebung, die im Wesentlichen eine ARM-Vorlagenbereitstellung ist.
EnvironmentDeploymentProperties	Eigenschaften einer Umgebungsbereitstellung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

ArmTemplateParameterProperties

Objekt

Eigenschaften eines Azure Resource Manager-Vorlagenparameters.

Name	Typ	Beschreibung
name	string	Der Name des Vorlagenparameters.
value	string	Der Wert des Vorlagenparameters.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DtlEnvironment

Objekt

Eine Umgebung, die im Wesentlichen eine ARM-Vorlagenbereitstellung ist.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.armTemplateDisplayName	string	Der Anzeigename der Azure Resource Manager-Vorlage, die die Umgebung erstellt hat.
properties.createdByUser	string	Der Ersteller der Umgebung
properties.deploymentProperties	EnvironmentDeploymentProperties	Die Bereitstellungseigenschaften der Umgebung.
properties.provisioningState	string	Der Bereitstellungsstatus der Ressource.
properties.resourceGroupId	string	Der Bezeichner der Ressourcengruppe, die die Ressourcen der Umgebung enthält.
properties.uniqueIdentifier	string	Der eindeutige unveränderliche Bezeichner einer Ressource (GUID).
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Objekt

Eigenschaften einer Umgebungsbereitstellung.

Name	Typ	Beschreibung
armTemplateId	string	Der Bezeichner der Azure Resource Manager-Vorlage.
parameters	ArmTemplateParameterProperties[]	Die Parameter der Azure Resource Manager-Vorlage.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.