Workspaces - List Workspaces

Service:
Admin
API-versie:
v1

Retourneert een lijst met werkruimten.
Deze API ondersteunt paginering. Er kunnen maximaal 10.000 records per aanvraag worden geretourneerd. Met het vervolgtoken in het antwoord kunt u de volgende 10.000 records ophalen.

Permissions

De aanroeper moet een Fabric-beheerder zijn of verifiëren met behulp van een service-principal.

Vereiste gedelegeerde bereiken

Tenant.Read.All of Tenant.ReadWrite.All

Limitations

Maximaal 200 aanvragen per uur.

Het encryptionStatus filter wordt alleen toegepast wanneer de include parameter bevat encryption.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Yes
serviceprincipal en beheerde identiteiten Yes

Interface

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

URI-parameters

Name In Vereist Type Description
capacityId
 query

string (uuid)

De capaciteits-id van de werkruimte.
continuationToken
 query

string

Vervolgtoken. Wordt gebruikt om de volgende items in de lijst op te halen.
encryptionStatus
 query

string

Geeft de CMK-versleutelingsstatus van de werkruimte aan en wordt gebruikt om werkruimten te filteren die overeenkomen met de opgegeven status.
include
 query

string

Hiermee geeft u aanvullende gegevens op die moeten worden opgenomen voor elke werkruimte in het antwoord. Ondersteunde waarden: encryption.
name
 query

string

De naam van de werkruimte.
state
 query

string

De werkruimtestatus. Ondersteunde statussen zijn actief en verwijderd.
type
 query

string

Het type werkruimte. Ondersteunde typen zijn persoonlijk, werkruimte, adminworkspace.

Antwoorden

Name Type Description
200 OK

Workspaces

De bewerking is geslaagd.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • BadRequest: queryparameters zoals workspaceType of workspaceState zijn niet geldig.

  • InsufficientPrivileges : de aanroeper heeft geen machtigingen om de API aan te roepen.

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Encryption

Details van werkruimteversleuteling met behulp van een door de klant beheerde sleutel (CMK).
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
Workspace

Workspace.
WorkspaceAppliedTag

Vertegenwoordigt een toegepaste tag.
WorkspaceEncryptionStatus

De CMK-versleutelingsstatus van de werkruimte.
Workspaces

Een lijst met werkruimten.
WorkspaceState

De werkruimtestatus. Er kunnen na verloop van tijd extra werkruimtestatussen worden toegevoegd.
WorkspaceType

Een werkruimtetype. Er kunnen in de loop van de tijd extra werkruimtetypen worden toegevoegd.

Encryption

Object

Details van werkruimteversleuteling met behulp van een door de klant beheerde sleutel (CMK).

Name Type Description
keyIdentifier

string

De id van de versleutelingssleutel.
previousKeyIdentifier

string

De vorige versleutelingssleutel-id.
previousStatus

WorkspaceEncryptionStatus

De vorige CMK-versleutelingsstatus van de werkruimte.
status

WorkspaceEncryptionStatus

De CMK-versleutelingsstatus van de werkruimte.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

Workspace

Object

Workspace.

Name Type Description
capacityId

string (uuid)

De capaciteits-id van de werkruimte.
domainId

string (uuid)

De domein-id van de werkruimte.
encryption

Encryption

De versleutelingsgegevens van de werkruimte.
id

string (uuid)

De werkruimte-ID.
name

string

De naam van de werkruimte.
state

WorkspaceState

De werkruimtestatus.
tags

WorkspaceAppliedTag[]

Lijst met toegepaste tags.
type

WorkspaceType

Het type werkruimte.

WorkspaceAppliedTag

Object

Vertegenwoordigt een toegepaste tag.

Name Type Description
displayName

string

De naam van de tag.
id

string (uuid)

De tag-id.

WorkspaceEncryptionStatus

Opsomming

De CMK-versleutelingsstatus van de werkruimte.

Waarde Description
Disabled

Werkruimteversleuteling is niet actief.
Active

Werkruimteversleuteling is actief en de werkruimte is versleuteld.
EnableInProgress

Werkruimteversleuteling wordt ingeschakeld.
DisableInProgress

Werkruimteversleuteling wordt uitgeschakeld.
Failed

Werkruimteversleutelingstoepassing is mislukt.

Workspaces

Object

Een lijst met werkruimten.

Name Type Description
continuationToken

string

Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri

string

De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
workspaces

Workspace[]

De lijst met infrastructuurwerkruimten.

WorkspaceState

Opsomming

De werkruimtestatus. Er kunnen na verloop van tijd extra werkruimtestatussen worden toegevoegd.

Waarde Description
Active

De werkruimte is actief. Zwevende werkruimten worden weergegeven als actief.
Deleted

De werkruimte wordt verwijderd.

WorkspaceType

Opsomming

Een werkruimtetype. Er kunnen in de loop van de tijd extra werkruimtetypen worden toegevoegd.

Waarde Description
Personal

Mijn map of Mijn werkruimte die wordt gebruikt voor het beheren van gebruikersitems.
Workspace

Werkruimte die wordt gebruikt voor het beheren van de Fabric-items.
AdminWorkspace

Werkruimte voor beheerbewaking. Bevat beheerdersrapporten, zoals het auditrapport en het gebruiks- en acceptatierapport.