Workspaces - List Workspaces

Tjeneste:
Admin
API-version:
v1

Returnerer en liste over arbejdsområder.

Note

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Denne API understøtter sideinddeling. Der kan maksimalt returneres 10.000 poster pr. anmodning. Med det fortsættelsestoken, der er angivet i svaret, kan du få de næste 10.000 poster.

Permissions

Den, der ringer op, skal være Fabric-administrator eller godkende ved hjælp af en tjenesteprincipal.

Påkrævede delegerede områder

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 200 anmodninger pr. time.

Filteret encryptionStatus anvendes kun, når parameteren include indeholder encryption.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity Support
User Yes
tjenesteprincipal og administrerede identiteter Yes

Interface

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

URI-parametre

Name I Påkrævet Type Beskrivelse
capacityId
 query

string (uuid)

Kapacitets-id'et for arbejdsområdet.
continuationToken
 query

string

Fortsættelsestoken. Bruges til at hente de næste elementer på listen.
encryptionStatus
 query

string

Angiver CMK-krypteringsstatus for arbejdsområdet og bruges til at filtrere arbejdsområder, der svarer til den angivne status.
include
 query

string

Angiver yderligere data, der skal medtages for hvert arbejdsområde i svaret. Understøttede værdier: encryption.
name
 query

string

Navnet på arbejdsområdet.
state
 query

string

Arbejdsområdetilstanden. Understøttede tilstande er aktive og slettet.
type
 query

string

Arbejdsområdetypen. Understøttede typer er personlige, arbejdsområder og administrationsarbejdsområder.

Svar

Name Type Beskrivelse
200 OK

Workspaces

Handlingen blev udført.
429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • BadRequest – Forespørgselsparametre, f.eks workspaceType . eller workspaceState er ikke gyldige.

  • InsufficientPrivileges – Kalderen har ikke tilladelse til at kalde 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

Eksempelanmodning

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

Eksempelanmodning

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.

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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

Definitioner

Name Beskrivelse
Encryption

Oplysninger om kryptering af arbejdsområdet ved hjælp af en kundeadministrerede nøgle (CMK).
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
Workspace

Workspace.
WorkspaceAppliedTag

Repræsenterer en anvendt kode.
WorkspaceEncryptionStatus

CMK-krypteringsstatus for arbejdsområdet.
Workspaces

En liste over arbejdsområder.
WorkspaceState

Arbejdsområdetilstanden. Der kan tilføjes flere arbejdsområdetilstande over tid.
WorkspaceType

En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

Encryption

Objekt

Oplysninger om kryptering af arbejdsområdet ved hjælp af en kundeadministrerede nøgle (CMK).

Name Type Beskrivelse
keyIdentifier

string

Krypteringsnøgle-id'et.
previousKeyIdentifier

string

Det forrige krypteringsnøgle-id.
previousStatus

WorkspaceEncryptionStatus

Den tidligere CMK-krypteringsstatus for arbejdsområdet.
status

WorkspaceEncryptionStatus

CMK-krypteringsstatus for arbejdsområdet.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable

boolean

Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

Workspace

Objekt

Workspace.

Name Type Beskrivelse
capacityId

string (uuid)

Kapacitets-id'et for arbejdsområdet.
domainId

string (uuid)

Arbejdsområdets domæne-id.
encryption

Encryption

Krypteringsoplysningerne for arbejdsområdet.
id

string (uuid)

Arbejdsområde-id'et.
name

string

Navnet på arbejdsområdet.
state

WorkspaceState

Arbejdsområdetilstanden.
tags

WorkspaceAppliedTag[]

Liste over anvendte mærker.
type

WorkspaceType

Arbejdsområdetypen.

WorkspaceAppliedTag

Objekt

Repræsenterer en anvendt kode.

Name Type Beskrivelse
displayName

string

Navnet på mærket.
id

string (uuid)

Tag-id'et.

WorkspaceEncryptionStatus

Optælling

CMK-krypteringsstatus for arbejdsområdet.

Værdi Beskrivelse
Disabled

Kryptering af arbejdsområdet er ikke aktiv.
Active

Kryptering af arbejdsområdet er aktiv, og arbejdsområdet er krypteret.
EnableInProgress

Kryptering af arbejdsområdet aktiveres.
DisableInProgress

Kryptering af arbejdsområdet deaktiveres.
Failed

Krypteringsprogrammet til arbejdsområdet mislykkedes.

Workspaces

Objekt

En liste over arbejdsområder.

Name Type Beskrivelse
continuationToken

string

Tokenet for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
continuationUri

string

URI'en for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
workspaces

Workspace[]

Listen over stofarbejdsområder.

WorkspaceState

Optælling

Arbejdsområdetilstanden. Der kan tilføjes flere arbejdsområdetilstande over tid.

Værdi Beskrivelse
Active

Arbejdsområdet er aktivt. Tabte arbejdsområder vises som aktive.
Deleted

Arbejdsområdet slettes.

WorkspaceType

Optælling

En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

Værdi Beskrivelse
Personal

Min mappe eller Mit arbejdsområde, der bruges til at administrere brugerelementer.
Workspace

Arbejdsområde, der bruges til at administrere Fabric-elementerne.
AdminWorkspace

Administrationsovervågningsarbejdsområde. Indeholder administratorrapporter, f.eks. overvågningsrapporten og forbrugs- og indføringsrapporten.