Workspaces - Set Network Communication Policy

Dienst:: Core

API-Version:: v1

Legt die Netzwerkkommunikationsrichtlinie für den angegebenen Arbeitsbereich fest.
Diese API verwendet die PUT-Methode und überschreibt alle Einstellungen. Wenn nur eine Teilrichtlinie im Anforderungstext bereitgestellt wird, werden die verbleibenden Einstellungen auf die Standardwerte festgelegt. Rufen Sie immer zuerst den Vorgang "Netzwerkkommunikationsrichtlinie abrufen" auf, und stellen Sie die vollständige Richtlinie im Anforderungstext bereit.

Note

Wenn defaultAction der Anforderungstext nicht angegeben wird, wird Allowstandardmäßig der Wert verwendet, der unbeabsichtigt eingehenden und ausgehenden Netzwerkzugriff geöffnet werden kann. Geben Sie immer explizit in jedem PUT-Anforderungstext an defaultAction .

Erlaubnisse

Der Anrufer muss über Administratorrolle Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

Workspace.ReadWrite.All

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

PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	Ein ETag-Wert. Das ETag muss in Anführungszeichen angegeben werden. Wenn angegeben, wird der Aufruf nur erfolgreich ausgeführt, wenn das ETag der Ressource mit dem bereitgestellten ETag übereinstimmt.

Anforderungstext

Name	Typ	Beschreibung
inbound	InboundRules	Die Eigenschaften der eingehenden Netzwerkkommunikation für einen Arbeitsbereich.
outbound	OutboundRules	Die Eigenschaften der ausgehenden Netzwerkkommunikation für einen Arbeitsbereich.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK		Die Anforderung wurde erfolgreich abgeschlossen. Header ETag: string
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert 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.

Die Anforderung wurde erfolgreich abgeschlossen.

Header

ETag: string

429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert 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

Set workspace networking communication policy example

Beispielanforderung

HTTP

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

{
  "inbound": {
    "publicAccessRules": {
      "defaultAction": "Allow"
    }
  },
  "outbound": {
    "publicAccessRules": {
      "defaultAction": "Deny"
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
InboundRules	Die Richtlinie für alle eingehenden Kommunikationen an einen Arbeitsbereich.
NetworkAccessRule	Die Standardrichtlinie für den Arbeitsbereichszugriff aus öffentlichen Netzwerken. Wenn sie von einem PUT-Anforderungstext nicht angegeben wird, wird `Allow`dieses Feld standardmäßig als "Netzwerkzugriff" festgelegt, wodurch der Netzwerkzugriff unbeabsichtigt geöffnet werden kann. Geben Sie dieses Feld immer explizit in jedem PUT-Anforderungstext an.
NetworkRules	Die Richtlinie, die den Zugriff auf/von einem Arbeitsbereich auf/von öffentlichen Netzwerken definiert.
OutboundRules	Die Richtlinie für alle ausgehenden Kommunikationen aus einem Arbeitsbereich.
WorkspaceNetworkingCommunicationPolicy	Die Netzwerkkommunikationsrichtlinie für einen Arbeitsbereich.

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.
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 lesbare 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 lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

InboundRules

Objekt

Die Richtlinie für alle eingehenden Kommunikationen an einen Arbeitsbereich.

Name	Typ	Beschreibung
publicAccessRules	NetworkRules	Die Richtlinie für eingehende Kommunikationen an einen Arbeitsbereich aus öffentlichen Netzwerken.

NetworkAccessRule

Enumeration

Die Standardrichtlinie für den Arbeitsbereichszugriff aus öffentlichen Netzwerken. Wenn sie von einem PUT-Anforderungstext nicht angegeben wird, wird Allowdieses Feld standardmäßig als "Netzwerkzugriff" festgelegt, wodurch der Netzwerkzugriff unbeabsichtigt geöffnet werden kann. Geben Sie dieses Feld immer explizit in jedem PUT-Anforderungstext an.

Wert	Beschreibung
Allow	Alle Verbindungen zulassen.
Deny	Alle Verbindungen verweigern.

NetworkRules

Objekt

Die Richtlinie, die den Zugriff auf/von einem Arbeitsbereich auf/von öffentlichen Netzwerken definiert.

Name	Typ	Beschreibung
defaultAction	NetworkAccessRule	Die Standardrichtlinie für den Arbeitsbereichszugriff aus öffentlichen Netzwerken. Wenn sie von einem PUT-Anforderungstext nicht angegeben wird, wird `Allow`dieses Feld standardmäßig als "Netzwerkzugriff" festgelegt, wodurch der Netzwerkzugriff unbeabsichtigt geöffnet werden kann. Geben Sie dieses Feld immer explizit in jedem PUT-Anforderungstext an.

OutboundRules

Objekt

Die Richtlinie für alle ausgehenden Kommunikationen aus einem Arbeitsbereich.

Name	Typ	Beschreibung
publicAccessRules	NetworkRules	Die Richtlinie für ausgehende Kommunikation mit öffentlichen Netzwerken aus einem Arbeitsbereich.

WorkspaceNetworkingCommunicationPolicy

Objekt

Die Netzwerkkommunikationsrichtlinie für einen Arbeitsbereich.

Name	Typ	Beschreibung
inbound	InboundRules	Die Eigenschaften der eingehenden Netzwerkkommunikation für einen Arbeitsbereich.
outbound	OutboundRules	Die Eigenschaften der ausgehenden Netzwerkkommunikation für einen Arbeitsbereich.