Workspaces - Get Outbound Gateway Rules

Υπηρεσία:: Core

Έκδοση API:: v1

Επιστρέφει τους κανόνες πύλης για τον χώρο εργασίας που είναι ενεργοποιημένος με την Προστασία εξερχόμενης πρόσβασης (OAP).
Αυτό το API βοηθά τους διαχειριστές χώρων εργασίας να προβάλουν τις αποτελεσματικές πολιτικές εξερχόμενης επικοινωνίας δικτύου που επιβάλλονται για πύλες δεδομένων εσωτερικής εγκατάστασης και VNet. Οι κανόνες πύλης επιστρέφονται και εφαρμόζονται μόνο εάν η πολιτική επικοινωνίας δικτύου του χώρου εργασίας έχει outbound.publicAccessRules.defaultAction οριστεί σε Deny. Εάν το OAP δεν είναι ενεργοποιημένο για τον χώρο εργασίας, το API αποτυγχάνει επειδή οι εξερχόμενες συνδέσεις δεν περιορίζονται.

Σημείωμα

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

Δικαιώματα

Ο καλών πρέπει να έχει ρόλο θεατή ή υψηλότερο χώρο εργασίας.

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

Workspace.Read.All ή Workspace.ReadWrite.All

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

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

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

Διεπαφή

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/outbound/gateways

Παράμετροι URI

Όνομα	Σε	Απαιτείται	Τύπος	Περιγραφή
workspaceId	path	True	string (uuid)	Μοναδικό αναγνωριστικό του χώρου εργασίας του οποίου υποβάλλονται ερωτήματα για τους κανόνες εξερχόμενης κυκλοφορίας.

Αποκρίσεις

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

200 OK

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

WorkspaceOutboundGateways

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

Κεφαλίδες

ETag: string

429 Too Many Requests

ErrorResponse

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

Κεφαλίδες

Retry-After: integer

Other Status Codes

ErrorResponse

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

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

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

Get workspace outbound access protection gateway rule for example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/outbound/gateways

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

Κωδικός κατάστασης:: 200

ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    }
  ]
}

Ορισμοί

Όνομα	Περιγραφή
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
GatewayAccessActionType	Καθορίζει τη συμπεριφορά ελέγχου πρόσβασης για τις εξερχόμενες πύλες. Αυτή η απαρίθμηση χρησιμοποιείται για το πεδίο defaultAction για να καθοριστεί εάν η εξερχόμενη επικοινωνία πρέπει να επιτρέπεται ή να απορρίπτεται από προεπιλογή. Αυτός ο τύπος επιτρέπει τόσο τον καθολικό έλεγχο όσο και τον έλεγχο της εξερχόμενης πρόσβασης για την πύλη, συμβάλλοντας στην επιβολή ασφαλών και προβλέψιμων πολιτικών επικοινωνίας δικτύου. Επιπλέον τύποι ενεργειών πρόσβασης πύλης μπορούν να προστεθούν με την πάροδο του χρόνου.
GatewayAccessRuleMetadata	Αντιπροσωπεύει μια πύλη που επιτρέπεται για εξερχόμενη επικοινωνία. Αυτό το αντικείμενο χρησιμοποιείται εντός των επιτρεπόμενων διαδρόμων για τη ρητή εξουσιοδότηση της εξερχόμενης πρόσβασης.
WorkspaceOutboundGateways	Αντιπροσωπεύει το πλήρες σύνολο των κανόνων προστασίας εξερχόμενης πρόσβασης πύλης που έχουν ρυθμιστεί για έναν χώρο εργασίας ως μέρος της πολιτικής επικοινωνίας δικτύωσης. Αυτό το αντικείμενο ορίζει τους κανόνες πύλης που διέπουν την εξερχόμενη επικοινωνία

ErrorRelatedResource

Αντικείμενο

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

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

ErrorResponse

Αντικείμενο

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

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

ErrorResponseDetails

Αντικείμενο

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

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

GatewayAccessActionType

Απαρίθμηση

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

Τιμή	Περιγραφή
Allow	Επιτρέπει τις εξερχόμενες πύλες. Όταν χρησιμοποιείται ως προεπιλεγμένη ενέργεια, επιτρέπονται όλες οι πύλες.
Deny	Αποκλείει τις εξερχόμενες πύλες. Όταν χρησιμοποιούνται ως προεπιλεγμένη ενέργεια, όλες οι πύλες απορρίπτονται, εκτός εάν επιτρέπεται ρητά.

GatewayAccessRuleMetadata

Αντικείμενο

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

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

WorkspaceOutboundGateways

Αντικείμενο

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

Όνομα	Τύπος	Περιγραφή
allowedGateways	GatewayAccessRuleMetadata[]	Μια λίστα κανόνων που καθορίζουν τη συμπεριφορά της εξερχόμενης πρόσβασης για τις πύλες.
defaultAction	GatewayAccessActionType	Καθορίζει την προεπιλεγμένη συμπεριφορά για όλες τις πύλες που δεν παρατίθενται ρητά στον πίνακα επιτρεπόμενων λ.π. Εάν οριστεί σε "Να επιτρέπεται", όλες οι μη καθορισμένες πύλες επιτρέπονται από προεπιλογή. Εάν οριστεί σε "Απόρριψη", αποκλείονται όλες οι μη καθορισμένες πύλες.