Workspaces - List Workspaces

Tjänst:
Admin
API-version:
v1

Returnerar en lista över arbetsytor.
Det här API:et stöder sidnumrering. Högst 10 000 poster kan returneras per begäran. Med fortsättningstoken som anges i svaret kan du hämta de kommande 10 000 posterna.

Permissions

Anroparen måste vara infrastrukturadministratör eller autentisera med hjälp av tjänstens huvudnamn.

Obligatoriska delegerade omfång

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maximalt 200 begäranden per timme.

encryptionStatus Filtret tillämpas endast när parametern include innehåller encryption.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity Support
User Yes
Tjänsthuvudnamn och hanterade identiteter Yes

Interface

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

URI-parametrar

Name I Obligatorisk Typ Description
capacityId
 query

string (uuid)

Arbetsytans kapacitets-ID.
continuationToken
 query

string

Fortsättningstoken. Används för att hämta nästa objekt i listan.
encryptionStatus
 query

string

Anger CMK-krypteringsstatusen för arbetsytan och används för att filtrera arbetsytor som matchar den angivna statusen.
include
 query

string

Anger ytterligare data som ska inkluderas för varje arbetsyta i svaret. Värden som stöds: encryption.
name
 query

string

Namnet på arbetsytan.
state
 query

string

Arbetsytans tillstånd. Tillstånd som stöds är aktiva och borttagna.
type
 query

string

Typ av arbetsyta. Typer som stöds är personliga, arbetsytor, administratörsarbetsyta.

Svar

Name Typ Description
200 OK

Workspaces

Åtgärden lyckades.
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • BadRequest – Frågeparametrar som workspaceType eller workspaceState är inte giltiga.

  • InsufficientPrivileges – anroparen har inte behörighet att anropa API:et.

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Encryption

Information om kryptering av arbetsytor med hjälp av en kundhanterad nyckel (CMK).
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
Workspace

Workspace.
WorkspaceAppliedTag

Representerar en tillämpad tagg.
WorkspaceEncryptionStatus

CMK-krypteringsstatus för arbetsytan.
Workspaces

En lista över arbetsytor.
WorkspaceState

Arbetsytans tillstånd. Ytterligare arbetsytetillstånd kan läggas till över tid.
WorkspaceType

En arbetsytetyp. Ytterligare arbetsytetyper kan läggas till över tid.

Encryption

Objekt

Information om kryptering av arbetsytor med hjälp av en kundhanterad nyckel (CMK).

Name Typ Description
keyIdentifier

string

Identifieraren för krypteringsnyckeln.
previousKeyIdentifier

string

Den tidigare krypteringsnyckelidentifieraren.
previousStatus

WorkspaceEncryptionStatus

Den tidigare CMK-krypteringsstatusen för arbetsytan.
status

WorkspaceEncryptionStatus

CMK-krypteringsstatus för arbetsytan.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

Workspace

Objekt

Workspace.

Name Typ Description
capacityId

string (uuid)

Arbetsytans kapacitets-ID.
domainId

string (uuid)

Arbetsytans domän-ID.
encryption

Encryption

Krypteringsinformationen för arbetsytan.
id

string (uuid)

Arbetsyte-ID.
name

string

Namnet på arbetsytan.
state

WorkspaceState

Arbetsytans tillstånd.
tags

WorkspaceAppliedTag[]

Lista över tillämpade taggar.
type

WorkspaceType

Typ av arbetsyta.

WorkspaceAppliedTag

Objekt

Representerar en tillämpad tagg.

Name Typ Description
displayName

string

Namnet på taggen.
id

string (uuid)

Tagg-ID:t.

WorkspaceEncryptionStatus

Uppräkning

CMK-krypteringsstatus för arbetsytan.

Värde Description
Disabled

Arbetsytekryptering är inte aktivt.
Active

Arbetsytekryptering är aktivt och arbetsytan är krypterad.
EnableInProgress

Kryptering av arbetsytor aktiveras.
DisableInProgress

Arbetsytekryptering inaktiveras.
Failed

Krypteringsprogrammet för arbetsytan misslyckades.

Workspaces

Objekt

En lista över arbetsytor.

Name Typ Description
continuationToken

string

Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri

string

URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
workspaces

Workspace[]

Listan över arbetsytor för infrastrukturresurser.

WorkspaceState

Uppräkning

Arbetsytans tillstånd. Ytterligare arbetsytetillstånd kan läggas till över tid.

Värde Description
Active

Arbetsytan är aktiv. Överblivna arbetsytor visas som aktiva.
Deleted

Arbetsytan tas bort.

WorkspaceType

Uppräkning

En arbetsytetyp. Ytterligare arbetsytetyper kan läggas till över tid.

Värde Description
Personal

Min mapp eller Min arbetsyta används för att hantera användarobjekt.
Workspace

Arbetsyta som används för att hantera infrastrukturobjekten.
AdminWorkspace

Arbetsyta för administratörsövervakning. Innehåller administratörsrapporter som granskningsrapporten och användnings- och implementeringsrapporten.