Workspaces - List Workspaces

Tjeneste:
Admin
API-versjon:
v1

Returnerer en liste over arbeidsområder.
Denne API-en støtter paginering. Maksimalt 10 000 poster kan returneres per forespørsel. Med fortsettelsestokenet som er angitt i svaret, kan du få de neste 10 000 postene.

Permissions

Innringeren må være en Fabric-administrator eller godkjenne ved hjelp av en tjenestekontohaver.

Nødvendige delegerte omfang

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 200 forespørsler per time.

Filteret encryptionStatus brukes bare når parameteren include inneholder encryption.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity Support
User Yes
tjenestekontohaver og administrerte identiteter Yes

Interface

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
capacityId
 query

string (uuid)

Kapasitets-ID-en for arbeidsområdet.
continuationToken
 query

string

Fortsettelsestoken. Brukes til å hente de neste elementene i listen.
encryptionStatus
 query

string

Angir CMK-krypteringsstatusen for arbeidsområdet og brukes til å filtrere arbeidsområder som samsvarer med den angitte statusen.
include
 query

string

Angir tilleggsdata som skal inkluderes for hvert arbeidsområde i svaret. Støttede verdier: encryption.
name
 query

string

Navnet på arbeidsområdet.
state
 query

string

Arbeidsområdetilstanden. Støttede tilstander er aktive og slettet.
type
 query

string

Arbeidsområdetypen. Støttede typer er personlige, arbeidsområder, administrasjonsområder.

Svar

Navn Type Beskrivelse
200 OK

Workspaces

Operasjonen var vellykket.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • BadRequest – spørringsparametere som workspaceType eller workspaceState ikke er gyldige.

  • InsufficientPrivileges – Innringeren har ikke tillatelse til å kalle API-en.

Eksempler

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Definisjoner

Navn Beskrivelse
Encryption

Krypteringsdetaljer for arbeidsområdet ved hjelp av en kundeadministrert nøkkel (CMK).
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
Workspace

Workspace.
WorkspaceAppliedTag

Representerer en brukt kode.
WorkspaceEncryptionStatus

CMK-krypteringsstatusen for arbeidsområdet.
Workspaces

En liste over arbeidsområder.
WorkspaceState

Arbeidsområdetilstanden. Flere arbeidsområdetilstander kan legges til over tid.
WorkspaceType

En arbeidsområdetype. Flere arbeidsområdetyper kan legges til over tid.

Encryption

Objekt

Krypteringsdetaljer for arbeidsområdet ved hjelp av en kundeadministrert nøkkel (CMK).

Navn Type Beskrivelse
keyIdentifier

string

Krypteringsnøkkelidentifikatoren.
previousKeyIdentifier

string

Den forrige krypteringsnøkkelidentifikatoren.
previousStatus

WorkspaceEncryptionStatus

Den forrige CMK-krypteringsstatusen for arbeidsområdet.
status

WorkspaceEncryptionStatus

CMK-krypteringsstatusen for arbeidsområdet.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

Workspace

Objekt

Workspace.

Navn Type Beskrivelse
capacityId

string (uuid)

Kapasitets-ID-en for arbeidsområdet.
domainId

string (uuid)

Domene-ID-en for arbeidsområdet.
encryption

Encryption

Krypteringsdetaljene for arbeidsområdet.
id

string (uuid)

Arbeidsområde-ID-en.
name

string

Navnet på arbeidsområdet.
state

WorkspaceState

Arbeidsområdetilstanden.
tags

WorkspaceAppliedTag[]

Liste over brukte merker.
type

WorkspaceType

Arbeidsområdetypen.

WorkspaceAppliedTag

Objekt

Representerer en brukt kode.

Navn Type Beskrivelse
displayName

string

Navnet på koden.
id

string (uuid)

Kode-ID-en.

WorkspaceEncryptionStatus

Opplisting

CMK-krypteringsstatusen for arbeidsområdet.

Verdi Beskrivelse
Disabled

Arbeidsområdekryptering er ikke aktivt.
Active

Arbeidsområdekryptering er aktivt og arbeidsområdet krypteres.
EnableInProgress

Arbeidsområdekryptering aktiveres.
DisableInProgress

Kryptering av arbeidsområdet deaktiveres.
Failed

Arbeidsområdekrypteringsprogrammet mislyktes.

Workspaces

Objekt

En liste over arbeidsområder.

Navn Type Beskrivelse
continuationToken

string

Tokenet for den neste resultatsettgruppen. Hvis det ikke er flere poster, fjernes den fra svaret.
continuationUri

string

URI-en for neste satsvise resultatsett. Hvis det ikke er flere poster, fjernes den fra svaret.
workspaces

Workspace[]

Listen over stoffarbeidsområder.

WorkspaceState

Opplisting

Arbeidsområdetilstanden. Flere arbeidsområdetilstander kan legges til over tid.

Verdi Beskrivelse
Active

Arbeidsområdet er aktivt. Frittstående arbeidsområder vises som aktive.
Deleted

Arbeidsområdet slettes.

WorkspaceType

Opplisting

En arbeidsområdetype. Flere arbeidsområdetyper kan legges til over tid.

Verdi Beskrivelse
Personal

Min mappe eller Mitt arbeidsområde brukes til å administrere brukerelementer.
Workspace

Arbeidsområde som brukes til å administrere stoffelementene.
AdminWorkspace

Arbeidsområde for administratorovervåking. Inneholder administratorrapporter som revisjonsrapporten og bruks- og innføringsrapporten.