Items - Get Environment Definition

Layanan:

Environment

Versi API:

v1

Mengembalikan definisi publik lingkungan yang ditentukan.
API ini mendukung operasi jangka panjang (LRO).

Ketika Anda mendapatkan definisi publik lingkungan, label sensitivitas bukan bagian dari definisi.

Permissions

Pemanggil harus memiliki izin baca dan tulis untuk lingkungan.

Cakupan yang Didelegasikan yang Diperlukan

Environment.ReadWrite.All atau Item.ReadWrite.All

Keterbatasan

API ini diblokir untuk lingkungan dengan label sensitivitas terenkripsi.

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}/getDefinition

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
environmentId	path	True	string (uuid)	ID lingkungan.
workspaceId	path	True	string (uuid)	ID ruangkerja.
format	query		string	Format definisi publik lingkungan.

Respons

Nama	Jenis	Deskripsi
200 OK	EnvironmentDefinitionResponse	Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima. Mengambil definisi 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.

Contoh

Get a environment definition example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/environments/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Respon sampel

Kode status:

200

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

Kode status:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
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.
EnvironmentDefinitionResponse	Respons definisi publik 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.

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.

EnvironmentDefinitionResponse

Objek

Respons definisi publik lingkungan.

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

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.