Workspaces - List Workspaces

Layanan:: Core

Versi API:: v1

Mengembalikan daftar ruang kerja yang dapat diakses oleh prinsipal. Gunakan parameter kueri peran untuk memfilter hasil menurut peran ruang kerja utama.
API ini mendukung penomoran halaman.

Cakupan yang Didelegasikan yang Diperlukan

Workspace.Read.All atau Workspace.ReadWrite.All

Batas Pengendalian

Jenis Batas	Value
Kuota Terpadu untuk API Platform	500 panggilan/menit
Batas API	500 panggilan/menit

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukungan
Pengguna	Ya
Prinsipal Layanan dan Identitas Terkelola	Ya

Antarmuka

GET https://api.fabric.microsoft.com/v1/workspaces

Dengan parameter opsional:

GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

Parameter URI

Nama	Dalam	Jenis	Deskripsi
continuationToken	query	string	Token untuk mengambil halaman hasil berikutnya.
preferWorkspaceSpecificEndpoints	query	boolean	Pengaturan yang mengontrol apakah akan menyertakan titik akhir API khusus ruang kerja per ruang kerja. True - Sertakan titik akhir API khusus ruang kerja, False - Jangan sertakan titik akhir API khusus ruang kerja.
roles	query	string	Daftar peran. Pisahkan nilai menggunakan koma. Jika tidak disediakan, semua ruang kerja dikembalikan.

Respons

Nama Jenis Deskripsi

200 OK

Nama	Jenis	Deskripsi
200 OK	Workspaces	Permintaan berhasil diselesaikan.
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header `Retry-After` yang menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: InvalidParameter - Peran ruang kerja tidak valid. UnknownError - Terjadi kesalahan.

Workspaces

Permintaan berhasil diselesaikan.

429 Too Many Requests

ErrorResponse

Batas tarif layanan terlampaui. Server mengembalikan header Retry-After yang menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Kode kesalahan umum:

InvalidParameter - Peran ruang kerja tidak valid.
UnknownError - Terjadi kesalahan.

Contoh

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

Definisi

Nama	Deskripsi
CapacityRegion	Wilayah kapasitas yang terkait dengan ruang kerja ini. Nilai wilayah kapasitas tambahan dapat ditambahkan dari waktu ke waktu.
ErrorParameter	Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
Workspace	Objek ruang kerja.
WorkspaceAppliedTag	Mewakili tag yang diterapkan.
Workspaces
WorkspaceType	Jenis ruang kerja. Jenis ruang kerja tambahan dapat ditambahkan dari waktu ke waktu.

CapacityRegion

Enumerasi

Wilayah kapasitas yang terkait dengan ruang kerja ini. Nilai wilayah kapasitas tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Australia East	Wilayah Australia Timur
Australia Southeast	Wilayah Australia Tenggara
Brazil South	Wilayah Brasil Selatan
Brazil Southeast	Wilayah Brasil Tenggara
Canada Central	Wilayah Kanada Tengah
Canada East	Wilayah Kanada Timur
Central India	Wilayah India Tengah
Central US	Wilayah AS Tengah
Central US EUAP	Wilayah EUAP AS Tengah
East Asia	Wilayah Asia Timur
East US	Wilayah US Timur
East US 2	Wilayah US Timur 2
France Central	Wilayah Prancis Tengah
France South	Wilayah Prancis Selatan
Germany Central	Wilayah Jerman Tengah
Germany Northeast	Wilayah Jerman Timur Laut
Israel Central	Wilayah Israel Tengah
Italy North	Wilayah Italia Utara
Japan East	Wilayah Jepang Timur
Japan West	Wilayah Jepang Barat
Korea Central	Wilayah Korea Tengah
Korea South	Wilayah Korea Selatan
Mexico Central	Wilayah Meksiko Tengah
North Central US	Wilayah US Tengah Utara
North Europe	Wilayah Eropa Utara
Norway East	Wilayah Norwegia Timur
Norway West	Wilayah Norwegia Barat
Poland Central	Wilayah Polandia Tengah
South Africa North	Wilayah Afrika Selatan Utara
South Africa West	Wilayah Afrika Selatan Barat
South Central US	Wilayah US Tengah Selatan
South India	Wilayah India Selatan
Southeast Asia	Wilayah Asia Tenggara
Spain Central	Wilayah Spanyol Tengah
Sweden Central	Wilayah Swedia Tengah
Switzerland North	Wilayah Swiss Utara
Switzerland West	Wilayah Swiss Barat
West Europe	Wilayah Eropa Barat
West India	Wilayah India Barat
West US	Wilayah US Barat
West US 2	Wilayah US Barat 2
West US 3	Wilayah US Barat 3
West Central US	Wilayah US Tengah Barat
UAE Central	Wilayah UAE Tengah
UAE North	Wilayah UAE Utara
Qatar Central	Wilayah Qatar Tengah
Germany West Central	Wilayah Jerman Barat Tengah
Germany North	Wilayah Jerman Utara
UK South	Wilayah Selatan Inggris
UK West	Wilayah UK Barat
China North	Wilayah Tiongkok Utara
China East	Wilayah Tiongkok Timur
China East 2	Wilayah Tiongkok Timur 2
China East 3	Wilayah Tiongkok Timur 3
China North 2	Wilayah Tiongkok Utara 2
China North 3	Wilayah Tiongkok Utara 3

ErrorParameter

Objek

Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.

Nama	Jenis	Deskripsi
message	string	Deskripsi yang dapat dibaca manusia tentang arti parameter.
name	string	Pengidentifikasi parameter.
value	string	Nilai parameter.

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.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. `Retry-After` Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
parameters	ErrorParameter[]	Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	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.
parameters	ErrorParameter[]	Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

Workspace

Objek

Objek ruang kerja.

Nama	Jenis	Deskripsi
apiEndpoint	string (uri)	URL HTTP yang mewakili titik akhir API khusus untuk ruang kerja. Nilai titik akhir ini dikembalikan saat pengguna mengaktifkan preferWorkspaceSpecificEndpoints. Ini memungkinkan akses API melalui tautan privat.
capacityId	string (uuid)	ID kapasitas tempat ruang kerja ditetapkan.
capacityRegion	CapacityRegion	Wilayah kapasitas yang terkait dengan ruang kerja ini.
description	string	Deskripsi ruang kerja.
displayName	string	Nama tampilan ruang kerja.
domainId	string (uuid)	ID domain tempat ruang kerja ditetapkan.
id	string (uuid)	ID ruangkerja.
tags	WorkspaceAppliedTag[]	Daftar tag yang diterapkan.
type	WorkspaceType	Jenis ruang kerja.

WorkspaceAppliedTag

Objek

Mewakili tag yang diterapkan.

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

Workspaces

Objek

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	Workspace[]	Daftar ruang kerja.

WorkspaceType

Enumerasi

Jenis ruang kerja. Jenis ruang kerja tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Personal	Folder saya atau Ruang kerja saya digunakan untuk mengelola item pengguna.
Workspace	Ruang kerja yang digunakan untuk mengelola item Fabric.
AdminWorkspace	Ruang kerja pemantauan admin. Berisi laporan admin seperti laporan audit dan laporan penggunaan dan adopsi.