Workspaces - List Workspaces

Hizmet:
Admin
API Sürümü:
v1

Çalışma alanlarının listesini döndürür.
Bu API, sayfalandırmadestekler. İstek başına en fazla 10.000 kayıt döndürülebilir. Yanıtta sağlanan devamlılık belirteci ile 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.

Filtre encryptionStatus yalnızca parametresi içerdiğinde includeencryptionuygulanır.

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}&encryptionStatus={encryptionStatus}&include={include}

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

string

Çalışma alanının CMK şifreleme durumunu gösterir ve belirtilen durumla eşleşen çalışma alanlarını filtrelemek için kullanılır.
include
 query

string

Yanıttaki her çalışma alanı için eklenecek ek verileri belirtir. Desteklenen değerler: encryption.
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
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

Örnek isteği

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

Örnek isteği

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
}

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

Örnek isteği

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

Örnek yanıt

Durum kodu:
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

Örnek isteği

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

Örnek yanıt

Durum kodu:
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

Örnek isteği

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

Örnek yanıt

Durum kodu:
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"
}

Tanımlar

Name Description
Encryption

Müşteri tarafından yönetilen anahtar (CMK) kullanarak çalışma alanı şifreleme ayrıntıları.
ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse

Hata yanıtı.
ErrorResponseDetails

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

Workspace.
WorkspaceAppliedTag

Uygulanan bir etiketi temsil eder.
WorkspaceEncryptionStatus

Çalışma alanının CMK şifreleme durumu.
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.

Encryption

Nesne

Müşteri tarafından yönetilen anahtar (CMK) kullanarak çalışma alanı şifreleme ayrıntıları.

Name Tür Description
keyIdentifier

string

Şifreleme anahtarı tanımlayıcısı.
previousKeyIdentifier

string

Önceki şifreleme anahtarı tanımlayıcısı.
previousStatus

WorkspaceEncryptionStatus

Çalışma alanının önceki CMK şifreleme durumu.
status

WorkspaceEncryptionStatus

Çalışma alanının CMK şifreleme durumu.

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

boolean

True olduğunda istek yeniden denenebilir. Varsa gecikmeyi Retry-After belirlemek için yanıt üst bilgisini kullanın.
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.
encryption

Encryption

Çalışma alanının şifreleme ayrıntıları.
id

string (uuid)

Çalışma alanı kimliği.
name

string

Çalışma alanı adı.
state

WorkspaceState

Çalışma alanı durumu.
tags

WorkspaceAppliedTag[]

Uygulanan etiketlerin listesi.
type

WorkspaceType

Çalışma alanı türü.

WorkspaceAppliedTag

Nesne

Uygulanan bir etiketi temsil eder.

Name Tür Description
displayName

string

Etiketin adı.
id

string (uuid)

Etiket kimliği.

WorkspaceEncryptionStatus

Numaralandırma

Çalışma alanının CMK şifreleme durumu.

Değer Description
Disabled

Çalışma alanı şifrelemesi etkin değil.
Active

Çalışma alanı şifrelemesi etkindir ve çalışma alanı şifrelenir.
EnableInProgress

Çalışma alanı şifrelemesi etkinleştiriliyor.
DisableInProgress

Çalışma alanı şifrelemesi devre dışı bırakılıyor.
Failed

Çalışma alanı şifreleme uygulaması başarısız oldu.

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.