Items - Update Environment Definition

Layanan:

Environment

Versi API:

v1

Mengambil alih definisi untuk lingkungan yang ditentukan.
API ini mendukung operasi jangka panjang (LRO).

Memperbarui definisi lingkungan, tidak memengaruhi label sensitivitasnya.

Permissions

Pemanggil harus memiliki izin baca dan tulis untuk lingkungan.

Cakupan yang Didelegasikan yang Diperlukan

Environment.ReadWrite.All atau Item.ReadWrite.All

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Support
Pengguna	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Antarmuka

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition

Dengan parameter opsional:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition?updateMetadata={updateMetadata}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
environmentId	path	True	string (uuid)	ID lingkungan.
workspaceId	path	True	string (uuid)	ID ruangkerja.
updateMetadata	query		boolean	Ketika diatur ke true dan file .platform disediakan sebagai bagian dari definisi, metadata item diperbarui menggunakan metadata dalam file .platform

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
definition	True	EnvironmentDefinition	Objek definisi publik lingkungan. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik lingkungan.

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima. Definisi pembaruan sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: OperationNotSupportedForItem - Operasi tidak didukung untuk item yang diminta. CorruptedPayload - Payload yang disediakan rusak.

Contoh

Update a environment definition example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respon sampel

Kode status:

200

Kode status:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definisi

Nama	Deskripsi
EnvironmentDefinition	Objek definisi publik lingkungan. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik lingkungan.
EnvironmentDefinitionPart	Objek bagian definisi lingkungan.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.
UpdateEnvironmentDefinitionRequest	Memperbarui payload permintaan definisi publik lingkungan.

EnvironmentDefinition

Objek

Objek definisi publik lingkungan. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik lingkungan.

Nama	Jenis	Deskripsi
format	string	Format definisi Lingkungan.
parts	EnvironmentDefinitionPart[]	Daftar bagian definisi.

EnvironmentDefinitionPart

Objek

Objek bagian definisi lingkungan.

Nama	Jenis	Deskripsi
path	string	Jalur bagian lingkungan.
payload	string	Payload bagian lingkungan.
payloadType	PayloadType	Jenis payload.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

PayloadType

Enumeration

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.

UpdateEnvironmentDefinitionRequest

Objek

Memperbarui payload permintaan definisi publik lingkungan.

Nama	Jenis	Deskripsi
definition	EnvironmentDefinition	Objek definisi publik lingkungan. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik lingkungan.