Workspaces - List Workspaces

Υπηρεσία:: Admin

Έκδοση API:: v1

Επιστρέφει μια λίστα χώρων εργασίας.

Note

Αυτό το API αποτελεί μέρος μιας έκδοσης προεπισκόπησης και παρέχεται μόνο για σκοπούς αξιολόγησης και ανάπτυξης. Μπορεί να αλλάξει με βάση τα σχόλια και δεν συνιστάται για χρήση στην παραγωγή.

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

Permissions

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

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

Tenant.Read.All ή Tenant.ReadWrite.All

Limitations

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

Υποστηριζόμενες ταυτότητες 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}

Παράμετροι URI

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

Αποκρίσεις

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

200 OK

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

Workspaces

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

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

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

Ορισμοί

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

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

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

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

ErrorResponseDetails

Object

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

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

Workspace

Object

Workspace.

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

Workspaces

Object

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

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

WorkspaceState

Απαρίθμηση

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

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

WorkspaceType

Απαρίθμηση

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

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

Κοινοποίηση μέσω

Workspaces - List Workspaces

Permissions

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

Limitations

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

Interface

Παράμετροι URI

Αποκρίσεις

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

Get a list of workspaces example

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

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

Get a list of workspaces using state query parameter example

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

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

Ορισμοί

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceState

WorkspaceType