Κοινή χρήση μέσω

Workspaces - List Workspaces

Υπηρεσία:
Core
Έκδοση API:
v1

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

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

Workspace.Read.All ή Workspace.ReadWrite.All

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

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

Ταυτότητα Υποστηρίζω
Χρήστης Ναι
Υπηρεσίας και διαχειριζόμενες ταυτότητες Ναι

Διεπαφή

GET https://api.fabric.microsoft.com/v1/workspaces
Με προαιρετικές παραμέτρους: 
GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

Παράμετροι URI

Όνομα Σε Απαιτείται Τύπος Περιγραφή
continuationToken
 query

string

Ένα διακριτικό για την ανάκτηση της επόμενης σελίδας αποτελεσμάτων.
preferWorkspaceSpecificEndpoints
 query

boolean

Μια ρύθμιση που ελέγχει εάν θα συμπεριληφθεί το τελικό σημείο API για συγκεκριμένο χώρο εργασίας ανά χώρο εργασίας. True - Συμπεριλάβετε το τελικό σημείο API για συγκεκριμένο χώρο εργασίας, False - Μην συμπεριλάβετε το τελικό σημείο API για συγκεκριμένο χώρο εργασίας.
roles
 query

string

Μια λίστα ρόλων. Διαχωρίστε τις τιμές χρησιμοποιώντας ένα κόμμα. Εάν δεν παρέχεται, επιστρέφονται όλοι οι χώροι εργασίας.

Αποκρίσεις

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

Workspaces

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

ErrorResponse

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

Κεφαλίδες

Retry-After: integer
Other Status Codes

ErrorResponse

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

  • InvalidParameter - Μη έγκυρος ρόλος χώρου εργασίας.

  • UnknownError - Παρουσιάστηκε σφάλμα.

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

List workspaces example
List workspaces with continuation example
List workspaces with preferWorkspaceSpecificEndpoints example
List workspaces with roles filter example

List workspaces example

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

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

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

Κωδικός κατάστασης:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

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

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

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

Κωδικός κατάστασης:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

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

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

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

Κωδικός κατάστασης:
200 
{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

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

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

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

Κωδικός κατάστασης:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

Ορισμοί

Όνομα Περιγραφή
ErrorRelatedResource

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

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

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

Ένα αντικείμενο χώρου εργασίας.
WorkspaceAppliedTag

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

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

ErrorRelatedResource

Αντικείμενο

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

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

string

Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType

string

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

ErrorResponse

Αντικείμενο

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

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

string

Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message

string

Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails

ErrorResponseDetails[]

Λίστα πρόσθετων λεπτομερειών σφάλματος.
relatedResource

ErrorRelatedResource

Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId

string (uuid)

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

ErrorResponseDetails

Αντικείμενο

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

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

string

Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message

string

Μια αναγνώσιμη αναπαράσταση του σφάλματος.
relatedResource

ErrorRelatedResource

Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

Workspace

Αντικείμενο

Ένα αντικείμενο χώρου εργασίας.

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

string (uri)

Διεύθυνση URL HTTP που αντιπροσωπεύει το τελικό σημείο API ειδικά για τον χώρο εργασίας. Αυτή η τιμή τελικού σημείου επιστρέφεται όταν ο χρήστης ενεργοποιεί την προτίμησηWorkspaceSpecificEndpoints. Επιτρέπει την πρόσβαση στο API μέσω ιδιωτικών συνδέσεων.
capacityId

string (uuid)

Το αναγνωριστικό των εκχωρημένων πόρων στους οποίους έχει αντιστοιχιστεί ο χώρος εργασίας.
description

string

Η περιγραφή του χώρου εργασίας.
displayName

string

Το εμφανιζόμενο όνομα του χώρου εργασίας.
domainId

string (uuid)

Το αναγνωριστικό του τομέα στον οποίο έχει αντιστοιχιστεί ο χώρος εργασίας.
id

string (uuid)

Το αναγνωριστικό χώρου εργασίας.
tags

WorkspaceAppliedTag[]

Λίστα εφαρμοσμένων ετικετών.
type

WorkspaceType

Ο τύπος χώρου εργασίας.

WorkspaceAppliedTag

Αντικείμενο

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

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

string

Το όνομα της ετικέτας.
id

string (uuid)

Το αναγνωριστικό ετικέτας.

Workspaces

Αντικείμενο
Όνομα Τύπος Περιγραφή
continuationToken

string

Το διακριτικό για την επόμενη δέσμη συνόλου αποτελεσμάτων. Εάν δεν υπάρχουν άλλες εγγραφές, καταργείται από την απόκριση.
continuationUri

string

Το URI της δέσμης επόμενου συνόλου αποτελεσμάτων. Εάν δεν υπάρχουν άλλες εγγραφές, καταργείται από την απόκριση.
value

Workspace[]

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

WorkspaceType

Απαρίθμηση

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

Τιμή Περιγραφή
Personal

Ο φάκελος μου ή Ο χώρος εργασίας μου χρησιμοποιείται για τη διαχείριση στοιχείων χρήστη.
Workspace

Χώρος εργασίας που χρησιμοποιείται για τη διαχείριση των στοιχείων Fabric.
AdminWorkspace

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