Items - List Environments

Layanan:: Environment

Versi API:: v1

Mengembalikan daftar lingkungan dari ruang kerja yang ditentukan.
API ini mendukung penomoran halaman.

Izin

Pemanggil harus memiliki peran ruang kerja penampil .

Cakupan yang Didelegasikan yang Diperlukan

Workspace.Read.All atau Workspace.ReadWrite.All

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

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

Dengan parameter opsional:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
workspaceId	path	True	string (uuid)	ID ruang kerja.
continuationToken	query		string	Token untuk mengambil halaman hasil berikutnya.
recursive	query		boolean	Mencantumkan item dalam folder dan folder berlapisnya, atau hanya folder. True - Semua item dalam folder dan folder berlapisnya tercantum, False - Hanya item dalam folder yang tercantum. Nilai defaultnya adalah true.
rootFolderId	query		string (uuid)	Parameter ini memungkinkan pengguna untuk memfilter item berdasarkan folder akar tertentu. Jika tidak disediakan, ruang kerja digunakan sebagai folder akar.

Respons

Nama	Jenis	Deskripsi
200 OK	Environments	Permintaan berhasil diselesaikan.
Other Status Codes	ErrorResponse	Kode kesalahan umum: InvalidItemType - Tipe item tidak valid

Nama

Jenis

Deskripsi

200 OK

Environments

Permintaan berhasil diselesaikan.

Other Status Codes

ErrorResponse

Kode kesalahan umum:

InvalidItemType - Tipe item tidak valid

Contoh

List environments in workspace example

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
ComponentPublishInfo	Terbitkan info untuk setiap komponen di lingkungan.
Environment	Item Lingkungan.
EnvironmentProperties	Properti lingkungan.
EnvironmentPublishState	Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.
Environments	Daftar lingkungan.
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.
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.

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.

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.

Environments

Objek

Daftar lingkungan.

Nama	Jenis	Deskripsi
continuationToken	string	Token untuk batch tataan hasil berikutnya. Jika tidak ada rekaman lagi, rekaman akan dihapus dari respons.
continuationUri	string	URI dari batch tataan hasil berikutnya. Jika tidak ada rekaman lagi, rekaman akan dihapus dari respons.
value	Environment[]	Daftar 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.

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.

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 - List Environments

Izin

Cakupan yang Didelegasikan yang Diperlukan

Identitas yang didukung Microsoft Entra

Antarmuka

Parameter URI

Respons

Contoh

List environments in workspace example

Permintaan sampel

Respon sampel

Definisi

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings