Workspaces - Set Network Communication Policy

Service:: Core

API-versie:: v1

Hiermee stelt u het netwerkcommunicatiebeleid voor de opgegeven werkruimte in.
Deze API maakt gebruik van de PUT-methode en overschrijft alle instellingen. Als er slechts een gedeeltelijk beleid wordt opgegeven in de aanvraagbody, worden de overige instellingen ingesteld op de standaardwaarden. Roep altijd eerst de bewerking Get Network Communication Policy aan en geef het volledige beleid op in de aanvraagbody.

Note

Als defaultAction deze wordt weggelaten uit de hoofdtekst van de aanvraag, wordt standaard Allowingesteld op , wat onbedoeld binnenkomende en uitgaande netwerktoegang kan openen. Geef altijd expliciet op defaultAction in elke PUT-aanvraagbody.

Permissions

De aanroeper moet beheerdersrol werkruimte hebben.

Vereiste gedelegeerde bereiken

Workspace.ReadWrite.All

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

Interface

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	Een ETag-waarde. De ETag moet tussen aanhalingstekens worden opgegeven. Indien opgegeven, slaagt de aanroep alleen als de ETag van de resource overeenkomt met de opgegeven ETag.

Aanvraagbody

Name	Type	Description
inbound	InboundRules	De eigenschappen voor binnenkomende netwerkcommunicatie voor een werkruimte.
outbound	OutboundRules	De eigenschappen voor uitgaande netwerkcommunicatie voor een werkruimte.

Antwoorden

Name Type Description

200 OK

Name	Type	Description
200 OK		De aanvraag is voltooid. Kopteksten ETag: string
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden.

De aanvraag is voltooid.

Kopteksten

ETag: string

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.

Voorbeelden

Set workspace networking communication policy example

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
InboundRules	Het beleid voor alle binnenkomende communicatie naar een werkruimte.
NetworkAccessRule	Het standaardbeleid voor toegang tot werkruimten vanuit openbare netwerken. Als u dit weglaat uit de hoofdtekst van een PUT-aanvraag, wordt dit veld standaard ingesteld `Allow`op , waardoor onbedoeld netwerktoegang kan worden geopend. Geef dit veld altijd expliciet op in elke PUT-aanvraagbody.
NetworkRules	Het beleid waarmee toegang tot/van een werkruimte naar/van openbare netwerken wordt gedefinieerd.
OutboundRules	Het beleid voor alle uitgaande communicatie vanuit een werkruimte.
WorkspaceNetworkingCommunicationPolicy	Het communicatiebeleid voor netwerken voor een werkruimte.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

InboundRules

Object

Het beleid voor alle binnenkomende communicatie naar een werkruimte.

Name	Type	Description
publicAccessRules	NetworkRules	Het beleid voor binnenkomende communicatie naar een werkruimte vanuit openbare netwerken.

NetworkAccessRule

Opsomming

Het standaardbeleid voor toegang tot werkruimten vanuit openbare netwerken. Als u dit weglaat uit de hoofdtekst van een PUT-aanvraag, wordt dit veld standaard ingesteld Allowop , waardoor onbedoeld netwerktoegang kan worden geopend. Geef dit veld altijd expliciet op in elke PUT-aanvraagbody.

Waarde	Description
Allow	Alle verbindingen toestaan.
Deny	Alle verbindingen weigeren.

NetworkRules

Object

Het beleid waarmee toegang tot/van een werkruimte naar/van openbare netwerken wordt gedefinieerd.

Name	Type	Description
defaultAction	NetworkAccessRule	Het standaardbeleid voor toegang tot werkruimten vanuit openbare netwerken. Als u dit weglaat uit de hoofdtekst van een PUT-aanvraag, wordt dit veld standaard ingesteld `Allow`op , waardoor onbedoeld netwerktoegang kan worden geopend. Geef dit veld altijd expliciet op in elke PUT-aanvraagbody.

OutboundRules

Object

Het beleid voor alle uitgaande communicatie vanuit een werkruimte.

Name	Type	Description
publicAccessRules	NetworkRules	Het beleid voor uitgaande communicatie naar openbare netwerken vanuit een werkruimte.

WorkspaceNetworkingCommunicationPolicy

Object

Het communicatiebeleid voor netwerken voor een werkruimte.

Name	Type	Description
inbound	InboundRules	De eigenschappen voor binnenkomende netwerkcommunicatie voor een werkruimte.
outbound	OutboundRules	De eigenschappen voor uitgaande netwerkcommunicatie voor een werkruimte.