Workspaces - Set Outbound Gateway Rules

Tjeneste:
Core
API-versjon:
v1

Angir gateway-reglene for arbeidsområdet som er aktivert med Utgående tilgangsbeskyttelse (OAP).
Denne API-en gjør det mulig for administratorer for arbeidsområder å definere, erstatte eller overstyre settet med utgående nettverkskommunikasjonspolicyer som styrer hvilke lokale /Vnet-datagatewayer som skal tillates fra gjeldende arbeidsområde.

Note

Beskyttelsesregler for utgående tilgang håndheves bare hvis arbeidsområdets nettverkskommunikasjonspolicy er outbound.publicAccessRules.defaultAction satt til Deny. Hvis OAP ikke er aktivert på arbeidsområdet, mislykkes API-en fordi utgående tilkoblinger ikke er begrenset.

Note

Denne API-en bruker PUT-metoden og overskriver alle utgående tilgangsgatewayer for arbeidsområdet. Kall alltid operasjonen Hent gatewayregler først, og oppgi den fullstendige policyen i forespørselsteksten.

Note

Hvis defaultAction den utelates fra forespørselsteksten, er den standard for Allow, noe som utilsiktet kan tillate alle utgående gateway-tilkoblinger. 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/outbound/gateways

URI-parametere

Name I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Unik identifikator for arbeidsområdet som skal oppdateres.

Brødtekst for forespørsel

Name Type Beskrivelse
allowedGateways

GatewayAccessRuleMetadata[]

En liste over regler som definerer utgående tilgangsvirkemåte for gatewayer.
defaultAction

GatewayAccessActionType

Definerer standard virkemåte for alle gatewayer som ikke er eksplisitt oppført i den tillatte listematrisen. Hvis angitt til «Tillat», er alle uspesifiserte gatewayer tillatt som standard. Hvis satt til «Avslå», blokkeres alle uspesifiserte gatewayer. Hvis dette feltet utelates Allowfra en PUT-forespørselstekst, vil dette feltet som standard tillate alle utgående gatewaytilkoblinger utilsiktet. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.

Svar

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

Eksempler

Set workspace outbound access protection gateway rule for example

Eksempelforespørsel

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

{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    },
    {
      "id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
    }
  ]
}

Eksempelsvar

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

Definisjoner

Name Beskrivelse
ErrorParameter

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
GatewayAccessActionType

Definerer virkemåten for tilgangskontroll for utgående gatewayer. Denne opplistingen brukes for feltet defaultAction til å angi om utgående kommunikasjon skal tillates eller nektes som standard. Denne typen muliggjør både global og gateway-spesifikk kontroll over utgående tilgang, noe som bidrar til å håndheve sikre og forutsigbare nettverkskommunikasjonspolicyer. Flere handlingstyper for gatewaytilgang kan legges til over tid.
GatewayAccessRuleMetadata

Representerer en gateway som er tillatt for utgående kommunikasjon. Dette objektet brukes i allowedGateways til eksplisitt å godkjenne utgående tilgang.
WorkspaceOutboundGateways

Representerer det fullstendige settet med utgående tilgangsbeskyttelsesregler for gateway som er konfigurert for et arbeidsområde som en del av kommunikasjonspolicyen for nettverk. Dette objektet definerer gatewayreglene som styrer utgående kommunikasjon

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name Type Beskrivelse
message

string

En lesbar beskrivelse av parameterens betydning.
name

string

Parameteridentifikatoren.
value

string

Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name 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.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name 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.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

GatewayAccessActionType

Opplisting

Definerer virkemåten for tilgangskontroll for utgående gatewayer. Denne opplistingen brukes for feltet defaultAction til å angi om utgående kommunikasjon skal tillates eller nektes som standard. Denne typen muliggjør både global og gateway-spesifikk kontroll over utgående tilgang, noe som bidrar til å håndheve sikre og forutsigbare nettverkskommunikasjonspolicyer. Flere handlingstyper for gatewaytilgang kan legges til over tid.

Verdi Beskrivelse
Allow

Tillater utgående gatewayer. Når de brukes som standardhandling, tillates alle gatewayer.
Deny

Blokkerer utgående gatewayer. Når de brukes som standardhandling, nektes alle gatewayer med mindre det er eksplisitt tillatt.

GatewayAccessRuleMetadata

Objekt

Representerer en gateway som er tillatt for utgående kommunikasjon. Dette objektet brukes i allowedGateways til eksplisitt å godkjenne utgående tilgang.

Name Type Beskrivelse
id

string (uuid)

Gateway-ID er tillatt.

WorkspaceOutboundGateways

Objekt

Representerer det fullstendige settet med utgående tilgangsbeskyttelsesregler for gateway som er konfigurert for et arbeidsområde som en del av kommunikasjonspolicyen for nettverk. Dette objektet definerer gatewayreglene som styrer utgående kommunikasjon

Name Type Beskrivelse
allowedGateways

GatewayAccessRuleMetadata[]

En liste over regler som definerer utgående tilgangsvirkemåte for gatewayer.
defaultAction

GatewayAccessActionType

Definerer standard virkemåte for alle gatewayer som ikke er eksplisitt oppført i den tillatte listematrisen. Hvis angitt til «Tillat», er alle uspesifiserte gatewayer tillatt som standard. Hvis satt til «Avslå», blokkeres alle uspesifiserte gatewayer. Hvis dette feltet utelates Allowfra en PUT-forespørselstekst, vil dette feltet som standard tillate alle utgående gatewaytilkoblinger utilsiktet. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.