Workspaces - Get Workspace

Layanan:

Admin

Versi API:

v1

Mengembalikan ruang kerja yang ditentukan.

Note

API ini adalah bagian dari rilis Pratinjau dan disediakan hanya untuk tujuan evaluasi dan pengembangan. Ini dapat berubah berdasarkan umpan balik dan tidak disarankan untuk penggunaan produksi.

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.

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/{workspaceId}

Parameter URI

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

Respons

Nama	Jenis	Deskripsi
200 OK	Workspace	OK
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: EntityNotFound - ID ruang kerja tidak ada. InsufficientPrivileges - Pemanggil tidak memiliki izin untuk memanggil API.

Contoh

Get workspace details by ID example

Permintaan sampel

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48

Respon sampel

Kode status:

200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "name": "test report",
  "type": "Workspace",
  "state": "Active",
  "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
  "domainId": "8badadb6-9945-4e07-8134-00e0defec00b",
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

Definisi

Nama	Deskripsi
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
Workspace	Workspace.
WorkspaceAppliedTag	Mewakili tag yang diterapkan.
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.

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.
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.

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.