Workspaces - List Workspaces

Hizmet:

Admin

API Sürümü:

v1

Çalışma alanlarının listesini döndürür.

Note

Bu API, önizleme sürümünün bir parçasıdır ve yalnızca değerlendirme ve geliştirme amacıyla sağlanır. Geri bildirim temelinde değişebilir ve üretim kullanımı için önerilmez.

Bu API, sayfalandırmadestekler. İstek başına en fazla 10.000 kayıt döndürülebilir. Yanıtta sağlanan sürekli belirteçle sonraki 10.000 kaydı alabilirsiniz.

Permissions

Çağıranın Doku yöneticisi olması veya hizmet sorumlusu kullanarak kimlik doğrulaması yapması gerekir.

Gerekli Temsilci Kapsamları

Tenant.Read.All veya Tenant.ReadWrite.All

Limitations

Saatte en fazla 200 istek.

Microsoft Entra destekli kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Identity	Support
User	Yes
Hizmet sorumlusu ve yönetilen kimlikler	Yes

Interface

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
capacityId	query		string (uuid)	Çalışma alanının kapasite kimliği.
continuationToken	query		string	Devamlılık belirteci. Listedeki sonraki öğeleri almak için kullanılır.
name	query		string	Çalışma alanı adı.
state	query		string	Çalışma alanı durumu. Desteklenen durumlar etkindir ve silinir.
type	query		string	Çalışma alanı türü. Desteklenen türler kişisel, çalışma alanı, adminworkspace'tir.

Yanıtlar

Name	Tür	Description
200 OK	Workspaces	İşlem başarılı oldu.
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Retry-After üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: BadRequest - veya gibi workspaceTypeworkspaceState sorgu parametreleri geçerli değil. InsufficientPrivileges - Çağıranın API'yi çağırma izinleri yoktur.

Örnekler

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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"
    }
  ],
  "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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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
}

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
Workspace	Workspace.
Workspaces	Çalışma alanlarının listesi.
WorkspaceState	Çalışma alanı durumu. Zaman içinde ek çalışma alanı durumları eklenebilir.
WorkspaceType	Çalışma alanı türü. Zaman içinde ek çalışma alanı türleri eklenebilir.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

Workspace

Nesne

Workspace.

Name	Tür	Description
capacityId	string (uuid)	Çalışma alanının kapasite kimliği.
domainId	string (uuid)	Çalışma alanının etki alanı kimliği.
id	string (uuid)	Çalışma alanı kimliği.
name	string	Çalışma alanı adı.
state	WorkspaceState	Çalışma alanı durumu.
type	WorkspaceType	Çalışma alanı türü.

Workspaces

Nesne

Çalışma alanlarının listesi.

Name	Tür	Description
continuationToken	string	Sonraki sonuç kümesi toplu işleminin belirteci. Başka kayıt yoksa yanıttan kaldırılır.
continuationUri	string	Sonraki sonuç kümesi toplu işleminin URI'sini. Başka kayıt yoksa yanıttan kaldırılır.
workspaces	Workspace[]	Doku çalışma alanlarının listesi.

WorkspaceState

Numaralandırma

Çalışma alanı durumu. Zaman içinde ek çalışma alanı durumları eklenebilir.

Değer	Description
Active	Çalışma alanı etkindir. Yalnız bırakılmış çalışma alanları etkin olarak görüntülenir.
Deleted	Çalışma alanı silinir.

WorkspaceType

Numaralandırma

Çalışma alanı türü. Zaman içinde ek çalışma alanı türleri eklenebilir.

Değer	Description
Personal	Kullanıcı öğelerini yönetmek için kullanılan Klasörüm veya Çalışma alanım.
Workspace	Doku öğelerini yönetmek için kullanılan çalışma alanı.
AdminWorkspace	Yönetici izleme çalışma alanı. Denetim raporu ve kullanım ve benimseme raporu gibi yönetici raporlarını içerir.