Workspaces - List Workspaces

Layanan:: Admin

Versi API:: v1

Mengembalikan daftar ruang kerja.
API ini mendukung penomoran halaman. Maksimal 10.000 rekaman dapat dikembalikan per permintaan. Dengan token kelanjutan yang disediakan dalam respons, Anda bisa mendapatkan 10.000 rekaman berikutnya.

Permissions

Pemanggil harus merupakan administrator Fabric atau mengautentikasi menggunakan perwakilan layanan.

Cakupan yang Didelegasikan yang Diperlukan

Tenant.Read.All atau Tenant.ReadWrite.All

Limitations

Maksimum 200 permintaan per jam.

Filter encryptionStatus hanya diterapkan saat include parameter berisi encryption.

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identity	Support
User	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Interface

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

Dengan parameter opsional:

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}&encryptionStatus={encryptionStatus}&include={include}

Parameter URI

Nama	Dalam	Jenis	Deskripsi
capacityId	query	string (uuid)	ID kapasitas ruang kerja.
continuationToken	query	string	Token kelanjutan. Digunakan untuk mendapatkan item berikutnya dalam daftar.
encryptionStatus	query	string	Menunjukkan status enkripsi CMK ruang kerja dan digunakan untuk memfilter ruang kerja yang cocok dengan status yang ditentukan.
include	query	string	Menentukan data tambahan yang akan disertakan untuk setiap ruang kerja dalam respons. Nilai yang didukung: `encryption`.
name	query	string	Nama ruang kerja.
state	query	string	Status ruang kerja. Status yang didukung aktif dan dihapus.
type	query	string	Jenis ruang kerja. Jenis yang didukung adalah pribadi, ruang kerja, ruang kerja admin.

Respons

Nama Jenis Deskripsi

200 OK

Nama	Jenis	Deskripsi
200 OK	Workspaces	Operasi berhasil.
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang `Retry-After` menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: BadRequest - Parameter kueri seperti `workspaceType` atau `workspaceState` tidak valid. InsufficientPrivileges - Pemanggil tidak memiliki izin untuk memanggil API.

Workspaces

Operasi berhasil.

429 Too Many Requests

ErrorResponse

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

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Kode kesalahan umum:

BadRequest - Parameter kueri seperti workspaceType atau workspaceState tidak valid.
InsufficientPrivileges - Pemanggil tidak memiliki izin untuk memanggil API.

Contoh

Get a list of workspaces example

Get a list of workspaces using state query parameter example

List workspaces for a given capacity, ignoring the encryptionStatus filter.

List workspaces with active encryption status in a given capacity

List workspaces with encryption details

Get a list of workspaces example

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Respon sampel

Kode status:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

Respon sampel

Kode status:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

Respon sampel

Kode status:: 200

{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

Respon sampel

Kode status:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definisi

Nama	Deskripsi
Encryption	Detail enkripsi ruang kerja menggunakan kunci yang dikelola pelanggan (CMK).
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
Workspace	Workspace.
WorkspaceAppliedTag	Mewakili tag yang diterapkan.
WorkspaceEncryptionStatus	Status enkripsi CMK ruang kerja.
Workspaces	Daftar ruang kerja.
WorkspaceState	Status ruang kerja. Status ruang kerja tambahan dapat ditambahkan dari waktu ke waktu.
WorkspaceType	Jenis ruang kerja. Jenis ruang kerja tambahan dapat ditambahkan dari waktu ke waktu.

Encryption

Objek

Detail enkripsi ruang kerja menggunakan kunci yang dikelola pelanggan (CMK).

Nama	Jenis	Deskripsi
keyIdentifier	string	Pengidentifikasi kunci enkripsi.
previousKeyIdentifier	string	Pengidentifikasi kunci enkripsi sebelumnya.
previousStatus	WorkspaceEncryptionStatus	Status enkripsi CMK sebelumnya dari ruang kerja.
status	WorkspaceEncryptionStatus	Status enkripsi CMK ruang kerja.

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.
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.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

Workspace

Objek

Workspace.

Nama	Jenis	Deskripsi
capacityId	string (uuid)	ID kapasitas ruang kerja.
domainId	string (uuid)	ID domain ruang kerja.
encryption	Encryption	Detail enkripsi ruang kerja.
id	string (uuid)	ID ruangkerja.
name	string	Nama ruang kerja.
state	WorkspaceState	Status ruang kerja.
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.

WorkspaceEncryptionStatus

Enumerasi

Status enkripsi CMK ruang kerja.

Nilai	Deskripsi
Disabled	Enkripsi ruang kerja tidak aktif.
Active	Enkripsi ruang kerja aktif dan ruang kerja dienkripsi.
EnableInProgress	Enkripsi ruang kerja diaktifkan.
DisableInProgress	Enkripsi ruang kerja sedang dinonaktifkan.
Failed	Aplikasi enkripsi ruang kerja gagal.

Workspaces

Objek

Daftar ruang kerja.

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

WorkspaceState

Enumerasi

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

Nilai	Deskripsi
Active	Ruang kerja aktif. Ruang kerja tanpa sumber ditampilkan sebagai aktif.
Deleted	Ruang kerja dihapus.

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.