Workspaces - List Workspaces

Služba:

Admin

Verze rozhraní API:

v1

Vrátí seznam pracovních prostorů.
Toto rozhraní API podporuje stránkování. Na požadavek lze vrátit maximálně 10 000 záznamů. S tokenem pokračování poskytnutým v odpovědi můžete získat dalších 10 000 záznamů.

Permissions

Volající musí být správce prostředků infrastruktury nebo se musí ověřit pomocí instančního objektu.

Požadované delegovaná rozsahy

Tenant.Read.All nebo Tenant.ReadWrite.All

Limitations

Maximálně 200 požadavků za hodinu.

Filtr encryptionStatus se použije pouze v případech, kdy include parametr obsahuje encryption.

Podporované identity v Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identity	Support
User	Yes
Hlavní služba a Spravované identity	Yes

Interface

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
capacityId	query		string (uuid)	ID kapacity pracovního prostoru.
continuationToken	query		string	Token pokračování Slouží k získání dalších položek v seznamu.
encryptionStatus	query		string	Označuje stav šifrování CMK pracovního prostoru a slouží k filtrování pracovních prostorů, které odpovídají zadanému stavu.
include	query		string	Určuje další data, která mají být zahrnuta pro každý pracovní prostor v odpovědi. Podporované hodnoty: encryption.
name	query		string	Název pracovního prostoru.
state	query		string	Stav pracovního prostoru. Podporované stavy jsou aktivní a odstraněné.
type	query		string	Typ pracovního prostoru. Podporované typy jsou osobní, pracovní prostor, adminworkspace.

Odpovědi

Name	Typ	Description
200 OK	Workspaces	Operace byla úspěšná.
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: BadRequest – Parametry dotazu, jako workspaceType jsou nebo workspaceState nejsou platné. InsufficientPrivileges – Volající nemá oprávnění k volání rozhraní API.

Příklady

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Encryption	Podrobnosti o šifrování pracovního prostoru pomocí klíče spravovaného zákazníkem (CMK).
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
Workspace	Workspace.
WorkspaceAppliedTag	Představuje použitou značku.
WorkspaceEncryptionStatus	Stav šifrování CMK pracovního prostoru.
Workspaces	Seznam pracovních prostorů
WorkspaceState	Stav pracovního prostoru. V průběhu času se můžou přidat další stavy pracovního prostoru.
WorkspaceType	Typ pracovního prostoru. V průběhu času je možné přidat další typy pracovních prostorů.

Encryption

Objekt

Podrobnosti o šifrování pracovního prostoru pomocí klíče spravovaného zákazníkem (CMK).

Name	Typ	Description
keyIdentifier	string	Identifikátor šifrovacího klíče.
previousKeyIdentifier	string	Předchozí identifikátor šifrovacího klíče.
previousStatus	WorkspaceEncryptionStatus	Předchozí stav šifrování CMK pracovního prostoru.
status	WorkspaceEncryptionStatus	Stav šifrování CMK pracovního prostoru.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

Workspace

Objekt

Workspace.

Name	Typ	Description
capacityId	string (uuid)	ID kapacity pracovního prostoru.
domainId	string (uuid)	ID domény pracovního prostoru.
encryption	Encryption	Podrobnosti o šifrování pracovního prostoru.
id	string (uuid)	Identifikátor pracovního prostoru.
name	string	Název pracovního prostoru.
state	WorkspaceState	Stav pracovního prostoru.
tags	WorkspaceAppliedTag[]	Seznam použitých značek
type	WorkspaceType	Typ pracovního prostoru.

WorkspaceAppliedTag

Objekt

Představuje použitou značku.

Name	Typ	Description
displayName	string	Název značky.
id	string (uuid)	ID značky.

WorkspaceEncryptionStatus

Výčet

Stav šifrování CMK pracovního prostoru.

Hodnota	Description
Disabled	Šifrování pracovního prostoru není aktivní.
Active	Šifrování pracovního prostoru je aktivní a pracovní prostor je šifrovaný.
EnableInProgress	Šifrování pracovního prostoru je povolené.
DisableInProgress	Šifrování pracovního prostoru se zakazuje.
Failed	Aplikace pro šifrování pracovního prostoru se nezdařila.

Workspaces

Objekt

Seznam pracovních prostorů

Name	Typ	Description
continuationToken	string	Token pro další dávku sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
continuationUri	string	Identifikátor URI další dávky sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
workspaces	Workspace[]	Seznam pracovních prostorů infrastruktury

WorkspaceState

Výčet

Stav pracovního prostoru. V průběhu času se můžou přidat další stavy pracovního prostoru.

Hodnota	Description
Active	Pracovní prostor je aktivní. Osamocené pracovní prostory se zobrazují jako aktivní.
Deleted	Pracovní prostor se odstraní.

WorkspaceType

Výčet

Typ pracovního prostoru. V průběhu času je možné přidat další typy pracovních prostorů.

Hodnota	Description
Personal	Složka nebo pracovní prostor použitý ke správě položek uživatelů
Workspace	Pracovní prostor používaný ke správě položek infrastruktury
AdminWorkspace	Pracovní prostor monitorování pro správce Obsahuje sestavy správců, jako je sestava auditu a sestava využití a přijetí.