Environments - Create Or Update

Usługa:

Dev Test Labs

Wersja API:

2018-09-15

Utwórz lub zastąp istniejące środowisko. Wykonanie tej operacji może zająć trochę czasu.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
labName	path	True	string	Nazwa laboratorium.
name	path	True	string	Nazwa środowiska.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
userName	path	True	string	Nazwa profilu użytkownika.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Ciało żądania

Nazwa	Typ	Opis
location	string	Lokalizacja geograficzna, w której znajduje się zasób
properties.armTemplateDisplayName	string	Nazwa wyświetlana szablonu usługi Azure Resource Manager, który wygenerował środowisko.
properties.deploymentProperties	EnvironmentDeploymentProperties	Właściwości wdrożenia środowiska.
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DtlEnvironment	Operacja aktualizacji zasobu "DtlEnvironment" powiodła się
201 Created	DtlEnvironment	Operacja tworzenia zasobu "DtlEnvironment" zakończyła się pomyślnie Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Environments_CreateOrUpdate

Przykładowa prośba

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

Przykładowa odpowiedź

Kod statusu:

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

Kod statusu:

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

Definicje

Nazwa	Opis
ArmTemplateParameterProperties	Właściwości parametru szablonu usługi Azure Resource Manager.
createdByType	Typ tożsamości, która utworzyła zasób.
DtlEnvironment	Środowisko, które jest zasadniczo wdrożeniem szablonu usługi ARM.
EnvironmentDeploymentProperties	Właściwości wdrożenia środowiska.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ArmTemplateParameterProperties

Sprzeciwiać się

Właściwości parametru szablonu usługi Azure Resource Manager.

Nazwa	Typ	Opis
name	string	Nazwa parametru szablonu.
value	string	Wartość parametru szablonu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DtlEnvironment

Sprzeciwiać się

Środowisko, które jest zasadniczo wdrożeniem szablonu usługi ARM.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.armTemplateDisplayName	string	Nazwa wyświetlana szablonu usługi Azure Resource Manager, który wygenerował środowisko.
properties.createdByUser	string	Twórca środowiska.
properties.deploymentProperties	EnvironmentDeploymentProperties	Właściwości wdrożenia środowiska.
properties.provisioningState	string	Stan aprowizacji zasobu.
properties.resourceGroupId	string	Identyfikator grupy zasobów zawierającej zasoby środowiska.
properties.uniqueIdentifier	string	Unikatowy niezmienny identyfikator zasobu (Guid).
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Sprzeciwiać się

Właściwości wdrożenia środowiska.

Nazwa	Typ	Opis
armTemplateId	string	Identyfikator szablonu usługi Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Parametry szablonu usługi Azure Resource Manager.

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

systemData

Sprzeciwiać się

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.