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


Gateways - Get Gateway

Σημείωση

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

Λήψη πύλης κατά αναγνωριστικό.

Δικαιώματα

Ο καλών πρέπει να έχει δικαιώματα για την πύλη.

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

Gateway.Read.All ή Gateway.ReadWrite.All

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

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

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

Διεπαφή

GET https://api.fabric.microsoft.com/v1/gateways/{gatewayId}

Παράμετροι URI

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

string

uuid

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

Αποκρίσεις

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

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

Other Status Codes

ErrorResponse

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

  • EntityNotFound - Δεν ήταν δυνατή η αναζήτηση του πόρου που ζητήθηκε.

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

Example

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

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

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

{
  "id": "8e41c4dd-a382-4937-9bf3-695ab881f7c2",
  "type": "OnPremises",
  "displayName": "ContosoOnPremisesGateway",
  "publicKey": {
    "exponent": "AQGB",
    "modulus": "od9b...90Jp1Q=="
  },
  "version": "3000.1.1",
  "numberOfMemberGateways": 2,
  "loadBalancingSetting": "DistributeEvenly",
  "allowCloudConnectionRefresh": true,
  "allowCustomConnectors": true
}

Ορισμοί

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

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

ErrorResponse

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

ErrorResponseDetails

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

GatewayType

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

LoadBalancingSetting

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

OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey

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

VirtualNetworkAzureResource

Οι ιδιότητες ενός πόρου Azure εικονικού δικτύου

VirtualNetworkGateway

ErrorRelatedResource

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

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

string

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

resourceType

string

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

ErrorResponse

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

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

string

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

message

string

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

moreDetails

ErrorResponseDetails[]

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

relatedResource

ErrorRelatedResource

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

requestId

string

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

ErrorResponseDetails

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

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

string

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

message

string

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

relatedResource

ErrorRelatedResource

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

GatewayType

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

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

Η πύλη εσωτερικής εγκατάστασης.

OnPremisesPersonal

Η πύλη εσωτερικής εγκατάστασης (προσωπική λειτουργία).

VirtualNetwork

Η πύλη εικονικού δικτύου.

LoadBalancingSetting

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

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

Οι αιτήσεις θα διανέμονται ομοιόμορφα μεταξύ όλων των ενεργοποιημένων μελών συμπλέγματος πυλών.

Failover

Οι αιτήσεις θα σταλούν στο πρώτο διαθέσιμο μέλος συμπλέγματος πύλης.

OnPremisesGateway

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

boolean

Εάν θα επιτρέπεται η ανανέωση των συνδέσεων cloud μέσω αυτής της πύλης εσωτερικής εγκατάστασης. True - Allow, False - Δεν επιτρέπεται.

allowCustomConnectors

boolean

Εάν θα επιτρέπεται η χρήση προσαρμοσμένων συνδέσεων με αυτήν την πύλη εσωτερικής εγκατάστασης. True - Allow, False - Δεν επιτρέπεται.

displayName

string

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

id

string

uuid

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

loadBalancingSetting

LoadBalancingSetting

Η ρύθμιση εξισορρόπησης φόρτου της πύλης εσωτερικής εγκατάστασης.

numberOfMemberGateways

integer

Ο αριθμός των μελών πύλης στην πύλη εσωτερικής εγκατάστασης.

publicKey

PublicKey

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

type string:

OnPremises

Ο τύπος της πύλης.

version

string

Η έκδοση του εγκατεστημένου κύριου μέλους πύλης.

OnPremisesGatewayPersonal

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

string

uuid

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

publicKey

PublicKey

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

type string:

OnPremisesPersonal

Ο τύπος της πύλης.

version

string

Η έκδοση της πύλης.

PublicKey

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

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

string

Ο εκθέτης του δημόσιου κλειδιού.

modulus

string

Ο συντελεστής του δημόσιου κλειδιού.

VirtualNetworkAzureResource

Οι ιδιότητες ενός πόρου Azure εικονικού δικτύου

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

string

Το όνομα της ομάδας πόρων

subnetName

string

Το όνομα του υποδικτύου

subscriptionId

string

uuid

Το αναγνωριστικό συνδρομής

virtualNetworkName

string

Το όνομα του εικονικού δικτύου

VirtualNetworkGateway

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

string

uuid

Το αναγνωριστικό αντικειμένου των εκχωρημένων πόρων άδειας χρήσης Fabric.

displayName

string

Το εμφανιζόμενο όνομα της πύλης εικονικού δικτύου.

id

string

uuid

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

inactivityMinutesBeforeSleep

integer

Τα λεπτά αδράνειας προτού η πύλη εικονικού δικτύου τεθεί σε κατάσταση αυτόματης αναστολής λειτουργίας.

numberOfMemberGateways

integer

Ο αριθμός των πυλών μελών.

type string:

VirtualNetwork

Ο τύπος της πύλης.

virtualNetworkAzureResource

VirtualNetworkAzureResource

Ο πόρος εικονικού δικτύου Azure.