Items - Create Environment

Layanan:: Environment

Versi API:: v1

Membuat lingkungan di ruang kerja yang ditentukan.
API ini mendukung operasi jangka panjang (LRO).

Izin

Pemanggil harus memiliki peran ruang kerja kontributor .

Cakupan yang Didelegasikan yang Diperlukan

Environment.ReadWrite.All atau Item.ReadWrite.All

Keterbatasan

Untuk membuat lingkungan, ruang kerja harus berada pada kapasitas Fabric yang didukung.

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukung
Pengguna	Ya
perwakilan Layanan dan identitas terkelola	Ya

Antarmuka

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
workspaceId	path	True	string (uuid)	ID ruang kerja.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
displayName	True	string	Nama tampilan lingkungan.
definition		EnvironmentDefinition	Definisi publik lingkungan.
description		string	Deskripsi lingkungan. Panjang maksimum adalah 256 karakter.
folderId		string (uuid)	ID folder. Jika tidak ditentukan atau null, lingkungan dibuat dengan ruang kerja sebagai foldernya.

Respons

Nama	Jenis	Deskripsi
201 Created	Environment	Berhasil dibuat
202 Accepted		Permintaan diterima, provisi lingkungan sedang berlangsung Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: InvalidItemType - Tipe item tidak valid ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan CorruptedPayload - Payload yang disediakan rusak. WorkspaceItemsLimitExceeded - Batas item ruang kerja terlampaui.

Nama

Jenis

Deskripsi

201 Created

Environment

Berhasil dibuat

202 Accepted

Permintaan diterima, provisi lingkungan sedang berlangsung

Header

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Kode kesalahan umum:

InvalidItemType - Tipe item tidak valid
ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan
CorruptedPayload - Payload yang disediakan rusak.
WorkspaceItemsLimitExceeded - Batas item ruang kerja terlampaui.

Contoh

Create an environment example

Create an environment with public definition example

Create an environment example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description."
}

Respon sampel

Kode status:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kode status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an environment with public definition example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "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:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kode status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definisi

Nama	Deskripsi
ComponentPublishInfo	Terbitkan info untuk setiap komponen di lingkungan.
CreateEnvironmentRequest	Buat payload permintaan lingkungan.
Environment	Item Lingkungan.
EnvironmentDefinition	Objek definisi publik lingkungan. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik lingkungan.
EnvironmentDefinitionPart	Objek bagian definisi lingkungan.
EnvironmentProperties	Properti lingkungan.
EnvironmentPublishState	Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
ItemTag	Mewakili tag yang diterapkan pada item.
ItemType	Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.
PublishDetails	Detail operasi penerbitan.
SparkLibraries	Pustaka Spark.
SparkSettings	Pengaturan Spark.

ComponentPublishInfo

Objek

Terbitkan info untuk setiap komponen di lingkungan.

Nama	Jenis	Deskripsi
sparkLibraries	SparkLibraries	Pustaka Spark menerbitkan informasi.
sparkSettings	SparkSettings	Pengaturan Spark menerbitkan informasi.

CreateEnvironmentRequest

Objek

Buat payload permintaan lingkungan.

Nama	Jenis	Deskripsi
definition	EnvironmentDefinition	Definisi publik lingkungan.
description	string	Deskripsi lingkungan. Panjang maksimum adalah 256 karakter.
displayName	string	Nama tampilan lingkungan.
folderId	string (uuid)	ID folder. Jika tidak ditentukan atau null, lingkungan dibuat dengan ruang kerja sebagai foldernya.

Environment

Objek

Item Lingkungan.

Nama	Jenis	Deskripsi
description	string	Deskripsi item.
displayName	string	Nama tampilan item.
folderId	string (uuid)	ID folder.
id	string (uuid)	ID item.
properties	EnvironmentProperties	Properti lingkungan.
tags	ItemTag[]	Daftar tag yang diterapkan.
type	ItemType	Jenis item.
workspaceId	string (uuid)	ID ruang kerja.

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.

EnvironmentProperties

Objek

Properti lingkungan.

Nama	Jenis	Deskripsi
publishDetails	PublishDetails	Detail operasi penerbitan lingkungan.

EnvironmentPublishState

Enumerasi

Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Success	Penerbitan lingkungan dalam keadaan sukses.
Cancelled	Penerbitan lingkungan dalam status dibatalkan.
Failed	Penerbitan lingkungan dalam status gagal.
Cancelling	Penerbitan lingkungan dalam status pembatalan.
Running	Penerbitan lingkungan dalam status berjalan.
Waiting	Penerbitan lingkungan dalam status menunggu.

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.

ItemTag

Objek

Mewakili tag yang diterapkan pada item.

Nama	Jenis	Deskripsi
displayName	string	Nama dari tag.
id	string (uuid)	ID tag.

ItemType

Enumerasi

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Dashboard	Dasbor PowerBI.
Report	Laporan PowerBI.
SemanticModel	Model semantik PowerBI.
PaginatedReport	Laporan paginasi PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Sebuah lakehouse.
Eventhouse	Sebuah rumah acara.
Environment	Lingkungan.
KQLDatabase	Database KQL.
KQLQueryset	Set kueri KQL.
KQLDashboard	Dasbor KQL.
DataPipeline	Alur data.
Notebook	Buku catatan.
SparkJobDefinition	Definisi pekerjaan spark.
MLExperiment	Eksperimen pembelajaran mesin.
MLModel	Model pembelajaran mesin.
Warehouse	Sebuah gudang.
Eventstream	Eventstream.
SQLEndpoint	Titik akhir SQL.
MirroredWarehouse	Sebuah gudang cermin.
MirroredDatabase	Database cermin.
Reflex	Sebuah Refleks.
GraphQLApi	API untuk item GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Sebuah SQLDatabase.
CopyJob	Pekerjaan Penyalinan.
VariableLibrary	VariabelLibrary.
Dataflow	Aliran Data.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Rekam jepret gudang.
DigitalTwinBuilder	Sebuah DigitalTwinBuilder.
DigitalTwinBuilderFlow	Alur Pembangun Kembar Digital.
MirroredAzureDatabricksCatalog	Katalog azure databricks cermin.
Map	Peta.
AnomalyDetector	Detektor Anomali.
UserDataFunction	Fungsi data pengguna.
GraphModel	Sebuah GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake Database untuk menyimpan tabel Iceberg yang dibuat dari akun Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Database Cosmos DB.
Ontology	Ontologi.
EventSchemaSet	An EventSchemaSet.

PayloadType

Enumerasi

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

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.

PublishDetails

Objek

Detail operasi penerbitan.

Nama	Jenis	Deskripsi
componentPublishInfo	ComponentPublishInfo	Komponen lingkungan menerbitkan informasi.
endTime	string (date-time)	Waktu akhir operasi penerbitan dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ss.sssssssZ.
startTime	string (date-time)	Waktu mulai operasi penerbitan dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ss.sssssZ.
state	EnvironmentPublishState	Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.
targetVersion	string (uuid)	Verifikasi target yang akan diterbitkan.

SparkLibraries

Objek

Pustaka Spark.

Nama	Jenis	Deskripsi
state	EnvironmentPublishState	Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.

SparkSettings

Objek

Pengaturan Spark.

Nama	Jenis	Deskripsi
state	EnvironmentPublishState	Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.

Bagikan melalui

Items - Create Environment

Izin

Cakupan yang Didelegasikan yang Diperlukan

Keterbatasan

Identitas yang didukung Microsoft Entra

Antarmuka

Parameter URI

Isi Permintaan

Respons

Contoh

Create an environment example

Permintaan sampel

Respon sampel

Create an environment with public definition example

Permintaan sampel

Respon sampel

Definisi

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings