Workspaces - List Workspaces

Služba:: Admin

Verze rozhraní API:: v1

Vrátí seznam pracovních prostorů.

Note

Toto rozhraní API je součástí verze Preview a poskytuje se pouze pro účely vyhodnocení a vývoje. Může se změnit na základě zpětné vazby a nedoporučuje se pro produkční použití.

Toto rozhraní API podporuje stránkování. Na požadavek lze vrátit maximálně 10 000 záznamů. S průběžným tokenem 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.

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}

Parametry identifikátoru URI

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

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.

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

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
}

Definice

Name	Description
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.
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ů.

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

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

Sdílet prostřednictvím

Workspaces - List Workspaces

Permissions

Požadované delegovaná rozsahy

Limitations

Podporované identity v Microsoft Entra

Interface

Parametry identifikátoru URI

Odpovědi

Příklady

Get a list of workspaces example

Ukázkový požadavek

Ukázková odpověď

Get a list of workspaces using state query parameter example

Ukázkový požadavek

Ukázková odpověď

Definice

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

WorkspaceAppliedTag

Workspaces

WorkspaceState

WorkspaceType