Workspaces - Set Network Communication Policy

Tjeneste:: Core

API-versjon:: v1

Angir kommunikasjonspolicyen for nettverk for det angitte arbeidsområdet.
Denne API-en bruker PUT-metoden og overskriver alle innstillingene. Hvis bare en delvis policy er angitt i brødteksten for forespørselen, settes gjenværende innstillinger til standardverdiene. Kall alltid operasjonen Hent policy for nettverkskommunikasjon først, og oppgi den fullstendige policyen i forespørselsteksten.

Note

Hvis defaultAction den utelates fra forespørselsteksten Allow, brukes standardinnstillingen , som utilsiktet kan åpne inngående og utgående nettverkstilgang. Angi alltid eksplisitt defaultAction i hver PUT-forespørselstekst.

Tillatelser

Innringeren må ha administrator arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Topptekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
If-Match		string	En ETag-verdi. ETag må angis i anførselstegn. Hvis angitt, vil kallet bare lykkes hvis ressursens ETag samsvarer med den angitte ETag.

Brødtekst for forespørsel

Navn	Type	Beskrivelse
inbound	InboundRules	De inngående nettverkskommunikasjonsegenskapene for et arbeidsområde.
outbound	OutboundRules	De utgående nettverkskommunikasjonsegenskapene for et arbeidsområde.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK		Forespørselen er fullført. Overskrifter ETag: string
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: UnknownError - Det oppstod en feil.

Forespørselen er fullført.

Overskrifter

ETag: string

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

UnknownError - Det oppstod en feil.

Eksempler

Set workspace networking communication policy example

Eksempelforespørsel

HTTP

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

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

Eksempelsvar

Statuskode:: 200

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

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
InboundRules	Policyen for all inngående kommunikasjon til et arbeidsområde.
NetworkAccessRule	Standardpolicyen for arbeidsområdetilgang fra offentlige nettverk. Hvis det utelates `Allow`fra en PUT-forespørselstekst, vil dette feltet som standard, som utilsiktet kan åpne nettverkstilgang. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.
NetworkRules	Policyen som definerer tilgang til/fra et arbeidsområde til/fra offentlige nettverk.
OutboundRules	Policyen for all utgående kommunikasjon fra et arbeidsområde.
WorkspaceNetworkingCommunicationPolicy	Kommunikasjonspolicyen for nettverk for et arbeidsområde.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

InboundRules

Objekt

Policyen for all inngående kommunikasjon til et arbeidsområde.

Navn	Type	Beskrivelse
publicAccessRules	NetworkRules	Policyen for inngående kommunikasjon til et arbeidsområde fra offentlige nettverk.

NetworkAccessRule

Opplisting

Standardpolicyen for arbeidsområdetilgang fra offentlige nettverk. Hvis det utelates Allowfra en PUT-forespørselstekst, vil dette feltet som standard, som utilsiktet kan åpne nettverkstilgang. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.

Verdi	Beskrivelse
Allow	Tillat alle tilkoblinger.
Deny	Avslå alle tilkoblinger.

NetworkRules

Objekt

Policyen som definerer tilgang til/fra et arbeidsområde til/fra offentlige nettverk.

Navn	Type	Beskrivelse
defaultAction	NetworkAccessRule	Standardpolicyen for arbeidsområdetilgang fra offentlige nettverk. Hvis det utelates `Allow`fra en PUT-forespørselstekst, vil dette feltet som standard, som utilsiktet kan åpne nettverkstilgang. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.

OutboundRules

Objekt

Policyen for all utgående kommunikasjon fra et arbeidsområde.

Navn	Type	Beskrivelse
publicAccessRules	NetworkRules	Policyen for utgående kommunikasjon til offentlige nettverk fra et arbeidsområde.

WorkspaceNetworkingCommunicationPolicy

Objekt

Kommunikasjonspolicyen for nettverk for et arbeidsområde.

Navn	Type	Beskrivelse
inbound	InboundRules	De inngående nettverkskommunikasjonsegenskapene for et arbeidsområde.
outbound	OutboundRules	De utgående nettverkskommunikasjonsegenskapene for et arbeidsområde.