Freigeben über

Workspaces - Get Outbound Gateway Rules

Dienst:
Core
API-Version:
v1

Gibt die Gatewayregeln für den Arbeitsbereich zurück, der mit dem Ausgehenden Zugriffsschutz (Outbound Access Protection, OAP) aktiviert ist. Diese API soll Arbeitsbereichsadministratoren dabei helfen, die effektiven Ausgehenden Netzwerkkommunikationsrichtlinien anzuzeigen, die für lokale und Vnet-Datengateways erzwungen werden. Gatewayregeln für ausgehenden Zugriff werden nur zurückgegeben und angewendet, wenn die Netzwerkkommunikationsrichtlinie des Arbeitsbereichs "outbound.publicAccessRules.defaultAction" auf "Verweigern" festgelegt ist. Wenn OAP im Arbeitsbereich nicht aktiviert ist, schlägt die API fehl, da ausgehende Verbindungen nicht eingeschränkt werden. Diese Funktion steht derzeit als Vorschau zur Verfügung.

Hinweis

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Erlaubnisse

Der Anrufer muss Viewer-rolle oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Support
Benutzer Yes
Service Principal und Verwaltete Identitäten Yes

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Eindeutiger Bezeichner des Arbeitsbereichs, dessen ausgehende Regeln abgefragt werden.

Antworten

Name Typ Beschreibung
200 OK

WorkspaceOutboundGateways

Die Anforderung wurde erfolgreich abgeschlossen.

Header

ETag: string
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get workspace outbound access protection gateway rule for example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    }
  ]
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
GatewayAccessActionType

Definiert das Zugriffssteuerungsverhalten für ausgehende Gateways. Diese Enumeration wird für das Feld defaultAction verwendet, um anzugeben, ob ausgehende Kommunikation standardmäßig zulässig oder verweigert werden soll. Dieser Typ ermöglicht sowohl globale als auch gatewayspezifische Kontrolle über ausgehenden Zugriff, wodurch sichere und vorhersehbare Netzwerkkommunikationsrichtlinien erzwungen werden. Zusätzliche Gatewayzugriffsaktionstypen können im Laufe der Zeit hinzugefügt werden.
GatewayAccessRuleMetadata

Stellt ein Gateway dar, das für ausgehende Kommunikation zulässig ist. Dieses Objekt wird innerhalb der allowedGateways verwendet, um den ausgehenden Zugriff explizit zu autorisieren.
WorkspaceOutboundGateways

Stellt den vollständigen Satz von Gateway-Schutzregeln für ausgehenden Zugriff dar, die für einen Arbeitsbereich im Rahmen der Netzwerkkommunikationsrichtlinie konfiguriert sind. Dieses Objekt definiert die Gatewayregeln, die ausgehende Kommunikation regeln.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

GatewayAccessActionType

Enumeration

Definiert das Zugriffssteuerungsverhalten für ausgehende Gateways. Diese Enumeration wird für das Feld defaultAction verwendet, um anzugeben, ob ausgehende Kommunikation standardmäßig zulässig oder verweigert werden soll. Dieser Typ ermöglicht sowohl globale als auch gatewayspezifische Kontrolle über ausgehenden Zugriff, wodurch sichere und vorhersehbare Netzwerkkommunikationsrichtlinien erzwungen werden. Zusätzliche Gatewayzugriffsaktionstypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Allow

Erlaubt ausgehende Gateways. Bei Verwendung als Standardaktion sind alle Gateways zulässig.
Deny

Blockiert ausgehende Gateways. Wenn sie als Standardaktion verwendet wird, werden alle Gateways verweigert, es sei denn, dies ist explizit zulässig.

GatewayAccessRuleMetadata

Objekt

Stellt ein Gateway dar, das für ausgehende Kommunikation zulässig ist. Dieses Objekt wird innerhalb der allowedGateways verwendet, um den ausgehenden Zugriff explizit zu autorisieren.

Name Typ Beschreibung
id

string (uuid)

Gateway-ID zulässig.

WorkspaceOutboundGateways

Objekt

Stellt den vollständigen Satz von Gateway-Schutzregeln für ausgehenden Zugriff dar, die für einen Arbeitsbereich im Rahmen der Netzwerkkommunikationsrichtlinie konfiguriert sind. Dieses Objekt definiert die Gatewayregeln, die ausgehende Kommunikation regeln.

Name Typ Beschreibung
allowedGateways

GatewayAccessRuleMetadata[]

Eine Liste der Regeln, die das Verhalten des ausgehenden Zugriffs für Gateways definieren.
defaultAction

GatewayAccessActionType

Definiert das Standardverhalten für alle Gateways, die nicht explizit im zulässigen Listenarray aufgeführt sind. Wenn diese Option auf "Zulassen" festgelegt ist, sind standardmäßig alle nicht angegebenen Gateways zulässig. Wenn diese Option auf "Verweigern" festgelegt ist, werden alle nicht angegebenen Gateways blockiert.