Workspaces - List Workspaces

Υπηρεσία:: Admin

Έκδοση API:: v1

Επιστρέφει μια λίστα χώρων εργασίας.
Αυτό το API υποστηρίζει σελιδοποίησης . Μπορούν να επιστραφούν έως 10.000 εγγραφές ανά αίτηση. Με το διακριτικό συνέχειας που παρέχεται στην απόκριση, μπορείτε να λάβετε τις επόμενες 10.000 εγγραφές.

Permissions

Ο καλών πρέπει να είναι διαχειριστής Fabric ή να εκτελεί έλεγχο ταυτότητας χρησιμοποιώντας μια κύρια υπηρεσία.

Απαιτούμενες εμβέλειες με ανάθεση

Tenant.Read.All ή Tenant.ReadWrite.All

Limitations

Το πολύ 200 αιτήσεις ανά ώρα.

Το encryptionStatus φίλτρο εφαρμόζεται μόνο όταν η παράμετρος include περιέχει encryption.

Υποστηριζόμενες ταυτότητες Microsoft Entra

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Identity	Support
User	Yes
Υπηρεσίας και διαχειριζόμενες ταυτότητες	Yes

Interface

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

Με προαιρετικές παραμέτρους:

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

Παράμετροι URI

Όνομα	Σε	Τύπος	Περιγραφή
capacityId	query	string (uuid)	Το αναγνωριστικό εκχωρημένων πόρων του χώρου εργασίας.
continuationToken	query	string	Διακριτικό συνέχειας. Χρησιμοποιείται για τη λήψη των επόμενων στοιχείων στη λίστα.
encryptionStatus	query	string	Υποδεικνύει την κατάσταση κρυπτογράφησης CMK του χώρου εργασίας και χρησιμοποιείται για το φιλτράρισμα χώρων εργασίας που συμφωνούν με την καθορισμένη κατάσταση.
include	query	string	Καθορίζει πρόσθετα δεδομένα που θα συμπεριληφθούν για κάθε χώρο εργασίας στην απόκριση. Υποστηριζόμενες τιμές: `encryption`.
name	query	string	Το όνομα του χώρου εργασίας.
state	query	string	Η κατάσταση του χώρου εργασίας. Οι υποστηριζόμενες πολιτείες είναι ενεργές και διαγράφονται.
type	query	string	Ο τύπος χώρου εργασίας. Οι υποστηριζόμενοι τύποι είναι προσωπικοί, χώρος εργασίας και χώρος εργασίας διαχείρισης.

Αποκρίσεις

Όνομα Τύπος Περιγραφή

200 OK

Όνομα	Τύπος	Περιγραφή
200 OK	Workspaces	Η επιχείρηση ολοκληρώθηκε με επιτυχία.
429 Too Many Requests	ErrorResponse	Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια `Retry-After` κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων. Κεφαλίδες Retry-After: integer
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: BadRequest - Παράμετροι ερωτήματος όπως `workspaceType` ή `workspaceState` δεν είναι έγκυρες. InsufficientPrivileges - Το πρόγραμμα κλήσης δεν έχει δικαιώματα κλήσης του API.

Workspaces

Η επιχείρηση ολοκληρώθηκε με επιτυχία.

429 Too Many Requests

ErrorResponse

Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια Retry-After κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων.

Κεφαλίδες

Retry-After: integer

Other Status Codes

ErrorResponse

Συνήθεις κωδικοί σφαλμάτων:

BadRequest - Παράμετροι ερωτήματος όπως workspaceType ή workspaceState δεν είναι έγκυρες.
InsufficientPrivileges - Το πρόγραμμα κλήσης δεν έχει δικαιώματα κλήσης του API.

Παραδείγματα

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

Δείγμα αίτησης

HTTP

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

Δείγμα απόκρισης

Κωδικός κατάστασης:: 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

Δείγμα αίτησης

HTTP

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

Δείγμα απόκρισης

Κωδικός κατάστασης:: 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.

Δείγμα αίτησης

HTTP

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

Δείγμα απόκρισης

Κωδικός κατάστασης:: 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

Δείγμα αίτησης

HTTP

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

Δείγμα απόκρισης

Κωδικός κατάστασης:: 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

Δείγμα αίτησης

HTTP

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

Δείγμα απόκρισης

Κωδικός κατάστασης:: 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"
}

Ορισμοί

Όνομα	Περιγραφή
Encryption	Λεπτομέρειες κρυπτογράφησης χώρου εργασίας χρησιμοποιώντας ένα κλειδί διαχειριζόμενο από τον πελάτη (CMK).
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
Workspace	Workspace.
WorkspaceAppliedTag	Αντιπροσωπεύει μια εφαρμοσμένη ετικέτα.
WorkspaceEncryptionStatus	Η κατάσταση κρυπτογράφησης CMK του χώρου εργασίας.
Workspaces	Μια λίστα χώρων εργασίας.
WorkspaceState	Η κατάσταση του χώρου εργασίας. Ενδέχεται να προστεθούν επιπλέον καταστάσεις χώρων εργασίας με την πάροδο του χρόνου.
WorkspaceType	Ένας τύπος χώρου εργασίας. Επιπλέον τύποι χώρου εργασίας μπορούν να προστεθούν με την πάροδο του χρόνου.

Encryption

Αντικείμενο

Λεπτομέρειες κρυπτογράφησης χώρου εργασίας χρησιμοποιώντας ένα κλειδί διαχειριζόμενο από τον πελάτη (CMK).

Όνομα	Τύπος	Περιγραφή
keyIdentifier	string	Το αναγνωριστικό κλειδιού κρυπτογράφησης.
previousKeyIdentifier	string	Το προηγούμενο αναγνωριστικό κλειδιού κρυπτογράφησης.
previousStatus	WorkspaceEncryptionStatus	Η προηγούμενη κατάσταση κρυπτογράφησης CMK του χώρου εργασίας.
status	WorkspaceEncryptionStatus	Η κατάσταση κρυπτογράφησης CMK του χώρου εργασίας.

ErrorRelatedResource

Αντικείμενο

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Όνομα	Τύπος	Περιγραφή
resourceId	string	Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType	string	Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Αντικείμενο

Η απόκριση σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
isRetriable	boolean	Όταν είναι true, η αίτηση μπορεί να επαναληφθεί. Χρησιμοποιήστε την `Retry-After` κεφαλίδα απόκρισης για να προσδιορίσετε την καθυστέρηση, εάν υπάρχει.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails	ErrorResponseDetails[]	Λίστα πρόσθετων λεπτομερειών σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId	string (uuid)	Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Αντικείμενο

Οι λεπτομέρειες της απόκρισης σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

Workspace

Αντικείμενο

Workspace.

Όνομα	Τύπος	Περιγραφή
capacityId	string (uuid)	Το αναγνωριστικό εκχωρημένων πόρων του χώρου εργασίας.
domainId	string (uuid)	Το αναγνωριστικό τομέα του χώρου εργασίας.
encryption	Encryption	Οι λεπτομέρειες κρυπτογράφησης του χώρου εργασίας.
id	string (uuid)	Το αναγνωριστικό χώρου εργασίας.
name	string	Το όνομα του χώρου εργασίας.
state	WorkspaceState	Η κατάσταση του χώρου εργασίας.
tags	WorkspaceAppliedTag[]	Λίστα εφαρμοσμένων ετικετών.
type	WorkspaceType	Ο τύπος χώρου εργασίας.

WorkspaceAppliedTag

Αντικείμενο

Αντιπροσωπεύει μια εφαρμοσμένη ετικέτα.

Όνομα	Τύπος	Περιγραφή
displayName	string	Το όνομα της ετικέτας.
id	string (uuid)	Το αναγνωριστικό ετικέτας.

WorkspaceEncryptionStatus

Απαρίθμηση

Η κατάσταση κρυπτογράφησης CMK του χώρου εργασίας.

Τιμή	Περιγραφή
Disabled	Η κρυπτογράφηση χώρου εργασίας δεν είναι ενεργή.
Active	Η κρυπτογράφηση χώρου εργασίας είναι ενεργή και ο χώρος εργασίας κρυπτογραφείται.
EnableInProgress	Η κρυπτογράφηση χώρου εργασίας είναι ενεργοποιημένη.
DisableInProgress	Η κρυπτογράφηση χώρου εργασίας απενεργοποιείται.
Failed	Η εφαρμογή κρυπτογράφησης χώρου εργασίας απέτυχε.

Workspaces

Αντικείμενο

Μια λίστα χώρων εργασίας.

Όνομα	Τύπος	Περιγραφή
continuationToken	string	Το διακριτικό για την επόμενη δέσμη συνόλου αποτελεσμάτων. Εάν δεν υπάρχουν άλλες εγγραφές, καταργείται από την απόκριση.
continuationUri	string	Το URI της δέσμης επόμενου συνόλου αποτελεσμάτων. Εάν δεν υπάρχουν άλλες εγγραφές, καταργείται από την απόκριση.
workspaces	Workspace[]	Η λίστα χώρων εργασίας fabric.

WorkspaceState

Απαρίθμηση

Η κατάσταση του χώρου εργασίας. Ενδέχεται να προστεθούν επιπλέον καταστάσεις χώρων εργασίας με την πάροδο του χρόνου.

Τιμή	Περιγραφή
Active	Ο χώρος εργασίας είναι ενεργός. Οι ορφανοί χώροι εργασίας εμφανίζονται ως ενεργοί.
Deleted	Ο χώρος εργασίας διαγράφεται.

WorkspaceType

Απαρίθμηση

Ένας τύπος χώρου εργασίας. Επιπλέον τύποι χώρου εργασίας μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
Personal	Ο φάκελος μου ή Ο χώρος εργασίας μου χρησιμοποιείται για τη διαχείριση στοιχείων χρήστη.
Workspace	Χώρος εργασίας που χρησιμοποιείται για τη διαχείριση των στοιχείων Fabric.
AdminWorkspace	Χώρος εργασίας παρακολούθησης διαχειριστή. Περιέχει αναφορές διαχειριστή, όπως η αναφορά ελέγχου και η αναφορά χρήσης και υιοθέτησης.