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

Gateways - List Gateway Role Assignments

  • Αναφορά
Υπηρεσία:
Core
Έκδοση API:
v1

Σημείωση

Αυτό το API είναι σε προεπισκόπηση.

Επιστρέφει μια λίστα αναθέσεων ρόλων πύλης.
Αυτό το API υποστηρίζει σελιδοποίησης .

Δικαιώματα

  • Ο καλών πρέπει να έχει connectionCreator ή υψηλότερο ρόλο στην πύλη.

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

Gateway.Read.All ή Gateway.ReadWrite.All

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

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

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

Διεπαφή

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

Παράμετροι URI

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

string

uuid

Το αναγνωριστικό της πύλης.
continuationToken
 query

string

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

Αποκρίσεις

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

GatewayRoleAssignments

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

ErrorResponse

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

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

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

List gateway role assignment example
List gateway role assignment with continuation example

List gateway role assignment example

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

GET https://api.fabric.microsoft.com/v1/gateways/8e41c4dd-a382-4937-9bf3-695ab881f7c2/roleAssignments

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

Κωδικός κατάστασης:
200 
{
  "value": [
    {
      "id": "ef543eb8-969c-46b0-a5a1-3f93351b6b31",
      "principal": {
        "id": "ef543eb8-969c-46b0-a5a1-3f93351b6b31",
        "type": "User"
      },
      "role": "Admin"
    },
    {
      "id": "5cf7d203-9123-4dff-a87f-7097dc4b5d60",
      "principal": {
        "id": "5cf7d203-9123-4dff-a87f-7097dc4b5d60",
        "type": "User"
      },
      "role": "ConnectionCreatorWithResharing"
    },
    {
      "id": "5931cd21-857f-42a5-beaf-0120e8b36542",
      "principal": {
        "id": "5931cd21-857f-42a5-beaf-0120e8b36542",
        "type": "User"
      },
      "role": "ConnectionCreator"
    },
    {
      "id": "97614f04-507c-4f6c-8dbc-da1845f582ef",
      "principal": {
        "id": "97614f04-507c-4f6c-8dbc-da1845f582ef",
        "type": "User"
      },
      "role": "ConnectionCreator"
    },
    {
      "id": "a5d9f30d-a15c-4fb9-b8ff-e2a884c9fd82",
      "principal": {
        "id": "a5d9f30d-a15c-4fb9-b8ff-e2a884c9fd82",
        "type": "Group"
      },
      "role": "ConnectionCreator"
    }
  ]
}

List gateway role assignment with continuation example

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

GET https://api.fabric.microsoft.com/v1/gateways/8e41c4dd-a382-4937-9bf3-695ab881f7c2/roleAssignments

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

Κωδικός κατάστασης:
200 
{
  "value": [
    {
      "id": "ef543eb8-969c-46b0-a5a1-3f93351b6b31",
      "principal": {
        "id": "ef543eb8-969c-46b0-a5a1-3f93351b6b31",
        "type": "User"
      },
      "role": "Admin"
    },
    {
      "id": "5cf7d203-9123-4dff-a87f-7097dc4b5d60",
      "principal": {
        "id": "5cf7d203-9123-4dff-a87f-7097dc4b5d60",
        "type": "User"
      },
      "role": "ConnectionCreatorWithResharing"
    },
    {
      "id": "5931cd21-857f-42a5-beaf-0120e8b36542",
      "principal": {
        "id": "5931cd21-857f-42a5-beaf-0120e8b36542",
        "type": "User"
      },
      "role": "ConnectionCreator"
    },
    {
      "id": "97614f04-507c-4f6c-8dbc-da1845f582ef",
      "principal": {
        "id": "97614f04-507c-4f6c-8dbc-da1845f582ef",
        "type": "User"
      },
      "role": "ConnectionCreator"
    },
    {
      "id": "a5d9f30d-a15c-4fb9-b8ff-e2a884c9fd82",
      "principal": {
        "id": "a5d9f30d-a15c-4fb9-b8ff-e2a884c9fd82",
        "type": "Group"
      },
      "role": "ConnectionCreator"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/gateways/8e41c4dd-a382-4937-9bf3-695ab881f7c2/roleAssignments?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Ορισμοί

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

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

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

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

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

Η ανάθεση ρόλου πύλης για μια κύρια.
GatewayRoleAssignments
GroupDetails

Λεπτομέρειες συγκεκριμένης ομάδας. Ισχύει όταν ο κύριος τύπος είναι Group.
GroupType

Ο τύπος της ομάδας. Επιπλέον τύποι ομάδων μπορούν να προστεθούν με την πάροδο του χρόνου.
Principal

Αντιπροσωπεύει μια ταυτότητα ή μια ομάδα Microsoft Entra.
PrincipalType

Ο τύπος της κύριας. Μπορείτε να προσθέσετε πρόσθετους κύριους τύπους με την πάροδο του χρόνου.
ServicePrincipalDetails

Λεπτομέρειες για την κύρια υπηρεσία. Ισχύει όταν ο κύριος τύπος είναι ServicePrincipal.
ServicePrincipalProfileDetails

Λεπτομέρειες προφίλ κύριας υπηρεσίας. Ισχύει όταν ο κύριος τύπος είναι ServicePrincipalProfile.
UserDetails

Συγκεκριμένες λεπτομέρειες για την κύρια χρήστη. Ισχύει όταν ο κύριος τύπος είναι User.

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

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

GatewayRole

Απαρίθμηση

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

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

Ενεργοποιεί την πρόσβαση διαχειριστή για την πύλη.
ConnectionCreator

Ενεργοποιεί την πρόσβαση του δημιουργού σύνδεσης για την πύλη.
ConnectionCreatorWithResharing

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

GatewayRoleAssignment

Object

Η ανάθεση ρόλου πύλης για μια κύρια.

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

string

uuid

Το αναγνωριστικό αντικειμένου της ανάθεσης ρόλου πύλης.
principal

Principal

Ο διευθυντής.
role

GatewayRole

Ο ρόλος πύλης της κύριας.

GatewayRoleAssignments

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

string

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

string

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

GatewayRoleAssignment[]

Μια λίστα αναθέσεων ρόλων πύλης.

GroupDetails

Object

Λεπτομέρειες συγκεκριμένης ομάδας. Ισχύει όταν ο κύριος τύπος είναι Group.

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

GroupType

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

GroupType

Απαρίθμηση

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

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

Το Principal είναι μια λίστα διανομής.
SecurityGroup

Το Principal είναι μια ομάδα ασφαλείας.
Unknown

Ο κύριος τύπος ομάδας είναι άγνωστος.

Principal

Object

Αντιπροσωπεύει μια ταυτότητα ή μια ομάδα Microsoft Entra.

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

string

Το εμφανιζόμενο όνομα της κύριας.
groupDetails

GroupDetails

Λεπτομέρειες συγκεκριμένης ομάδας. Ισχύει όταν ο κύριος τύπος είναι Group.
id

string

uuid

Το αναγνωριστικό του διευθυντή.
servicePrincipalDetails

ServicePrincipalDetails

Λεπτομέρειες για την κύρια υπηρεσία. Ισχύει όταν ο κύριος τύπος είναι ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Λεπτομέρειες προφίλ κύριας υπηρεσίας. Ισχύει όταν ο κύριος τύπος είναι ServicePrincipalProfile.
type

PrincipalType

Ο τύπος της κύριας. Μπορείτε να προσθέσετε πρόσθετους κύριους τύπους με την πάροδο του χρόνου.
userDetails

UserDetails

Συγκεκριμένες λεπτομέρειες για την κύρια χρήστη. Ισχύει όταν ο κύριος τύπος είναι User.

PrincipalType

Απαρίθμηση

Ο τύπος της κύριας. Μπορείτε να προσθέσετε πρόσθετους κύριους τύπους με την πάροδο του χρόνου.

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

Το Principal είναι μια ομάδα ασφαλείας.
ServicePrincipal

Το Principal είναι μια κύρια υπηρεσία Microsoft Entra.
ServicePrincipalProfile

Το Principal είναι ένα προφίλ κύριας υπηρεσίας.
User

Το Principal είναι μια κύρια χρήστης του Microsoft Entra.

ServicePrincipalDetails

Object

Λεπτομέρειες για την κύρια υπηρεσία. Ισχύει όταν ο κύριος τύπος είναι ServicePrincipal.

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

string

uuid

Το Microsoft Entra AppId της κύριας υπηρεσίας.

ServicePrincipalProfileDetails

Object

Λεπτομέρειες προφίλ κύριας υπηρεσίας. Ισχύει όταν ο κύριος τύπος είναι ServicePrincipalProfile.

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

Principal

Η γονική οντότητα του προφίλ κύριας υπηρεσίας.

UserDetails

Object

Συγκεκριμένες λεπτομέρειες για την κύρια χρήστη. Ισχύει όταν ο κύριος τύπος είναι User.

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

string

Το κύριο όνομα χρήστη.