Environments - Create Or Update

Layanan:

Dev Test Labs

Versi API:

2018-09-15

Membuat atau mengganti lingkungan yang ada. Operasi ini bisa memakan waktu cukup lama untuk diselesaikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
labName	path	True	string	Nama lab.
name	path	True	string	Nama lingkungan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
userName	path	True	string	Nama profil pengguna.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
location	string	Lokasi geografis tempat sumber daya berada
properties.armTemplateDisplayName	string	Nama tampilan templat Azure Resource Manager yang menghasilkan lingkungan.
properties.deploymentProperties	EnvironmentDeploymentProperties	Properti penyebaran lingkungan.
tags	object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	DtlEnvironment	Operasi pembaruan 'DtlEnvironment' sumber daya berhasil
201 Created	DtlEnvironment	Resource 'DtlEnvironment' membuat operasi berhasil Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Environments_CreateOrUpdate

Permintaan sampel

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

Respon sampel

Kode status:

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

Kode status:

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

Definisi

Nama	Deskripsi
ArmTemplateParameterProperties	Properti parameter templat Azure Resource Manager.
createdByType	Jenis identitas yang membuat sumber daya.
DtlEnvironment	Lingkungan, yang pada dasarnya merupakan penyebaran templat ARM.
EnvironmentDeploymentProperties	Properti penyebaran lingkungan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

ArmTemplateParameterProperties

Objek

Properti parameter templat Azure Resource Manager.

Nama	Jenis	Deskripsi
name	string	Nama parameter templat.
value	string	Nilai parameter templat.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DtlEnvironment

Objek

Lingkungan, yang pada dasarnya merupakan penyebaran templat ARM.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.armTemplateDisplayName	string	Nama tampilan templat Azure Resource Manager yang menghasilkan lingkungan.
properties.createdByUser	string	Pencipta lingkungan.
properties.deploymentProperties	EnvironmentDeploymentProperties	Properti penyebaran lingkungan.
properties.provisioningState	string	Status provisi sumber daya.
properties.resourceGroupId	string	Pengidentifikasi grup sumber daya yang berisi sumber daya lingkungan.
properties.uniqueIdentifier	string	Pengidentifikasi unik yang tidak dapat diubah dari sumber daya (Guid).
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Objek

Properti penyebaran lingkungan.

Nama	Jenis	Deskripsi
armTemplateId	string	Pengidentifikasi templat Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Parameter templat Azure Resource Manager.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.