Workspaces - Get Firewall Rules

Dienst:
Core
API-Version:
v1

Gibt die IP-Firewallregeln für den Arbeitsbereich zurück. Diese API soll Arbeitsbereichsadministratoren dabei helfen, die effektiven IP-Firewallregeln anzuzeigen. Diese Funktion steht derzeit als Vorschau zur Verfügung.

Note

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 Zugriffsbereiche

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.

Identity Support
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Eindeutiger Bezeichner des Arbeitsbereichs, dessen Firewallregeln abgefragt werden.

Antworten

Name Typ Beschreibung
200 OK

InboundFirewallConfiguration

Der Auftrag wurde erfolgreich abgeschlossen.

Kopfzeilen:

Etagstring – Das aktuelle ETag der Firewallkonfiguration. Verwenden Sie diesen Wert in der Kopfzeile eines nachfolgenden PUT-Aufrufs If-Match , um optimistisches Parallelitätssteuerelement anzuwenden.
429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Example for getting workspace firewall rules

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
FirewallRule

Definiert eine Firewallregel, die durch ihren Namen identifiziert wird und eine einzelne IP-Adresse, einen IP-Adressbereich oder eine CIDR-IP-Adresse als Wert enthält.
InboundFirewallConfiguration

Dieses Objekt definiert den vollständigen Satz von Firewallregeln, um den Schutz des eingehenden Zugriffs als Teil der Netzwerkkommunikationsrichtlinie eines Arbeitsbereichs zu verwalten. Dadurch wird sichergestellt, dass nur explizit autorisierte IP-Adressen für eingehende Kommunikation zulässig sind. Wenn dieses Objekt über die PUT-API übermittelt wird, wird die vorhandene IP-Firewallkonfiguration für den Arbeitsbereich erstellt oder vollständig ersetzt. Diese Regeln werden nur erzwungen, wenn die Netzwerkkommunikationsrichtlinie des Arbeitsbereichs "bound.publicAccessRules.defaultAction" auf "Verweigern" festgelegt ist.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

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.
isRetriable

boolean

Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message

string

Eine menschenlesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string (uuid)

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 menschenlesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

FirewallRule

Objekt

Definiert eine Firewallregel, die durch ihren Namen identifiziert wird und eine einzelne IP-Adresse, einen IP-Adressbereich oder eine CIDR-IP-Adresse als Wert enthält.

Name Typ Beschreibung
displayName

string

Gibt den Namen der Regel an. Anzeigenamen können bis zu 128 Zeichen lang sein und müssen pro Arbeitsbereich eindeutig sein.
value

string

Gibt den Wert der Regel an, die als einzelne IP-Adresse, einen IP-Adressbereich oder eine CIDR-IP-Adresse angegeben wird.

InboundFirewallConfiguration

Objekt

Dieses Objekt definiert den vollständigen Satz von Firewallregeln, um den Schutz des eingehenden Zugriffs als Teil der Netzwerkkommunikationsrichtlinie eines Arbeitsbereichs zu verwalten. Dadurch wird sichergestellt, dass nur explizit autorisierte IP-Adressen für eingehende Kommunikation zulässig sind. Wenn dieses Objekt über die PUT-API übermittelt wird, wird die vorhandene IP-Firewallkonfiguration für den Arbeitsbereich erstellt oder vollständig ersetzt. Diese Regeln werden nur erzwungen, wenn die Netzwerkkommunikationsrichtlinie des Arbeitsbereichs "bound.publicAccessRules.defaultAction" auf "Verweigern" festgelegt ist.

Name Typ Beschreibung
rules

FirewallRule[]

Eine Liste der Regeln, die IP-Adressen definieren, die für eingehenden Zugriff zulässig sind. Jede Regel kann einen Namen und eine einzelne IP-Adresse, einen IP-Adressbereich oder eine CIDR-IP-Adresse enthalten. Pro Arbeitsbereich können maximal 256 Regeln angegeben werden.