Workspaces - Set Firewall Rules

Tjeneste:: Core

API-versjon:: v1

Angir IP-brannmurreglene for arbeidsområdet. Denne API-en gjør det mulig for administratorer av arbeidsområdet å angi IP-brannmurregler som styrer hvilke IP-adresser som skal kunne kobles til arbeidsområdet. Denne funksjonen er en forhåndsvisningsfunksjon.

Bemerkning

Denne API-en er en del av en forhåndsversjon, og er bare tilgjengelig for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk.

Bemerkning

Brannmurregler håndheves bare hvis arbeidsområdets nettverkskommunikasjonspolicy har inbound.publicAccessRules.defaultAction satt til Avslå. Hvis offentlig tilgang ikke er blokkert på arbeidsområdet, vil ikke API-kall til dette arbeidsområdet begrenses.

Bemerkning

Denne API-en bruker PUT-metoden og overskriver alle IP-brannmurregler for arbeidsområdet. Kjør alltid Hent først, og oppgi alle IP-brannmurregler i brødteksten for forespørselen.

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	Kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Unik identifikator for arbeidsområdet som skal oppdateres.

Brødtekst for forespørsel

Navn	Type	Beskrivelse
rules	FirewallRule[]	En liste over regler som definerer IP-adresser som er tillatt for innkommende tilgang. Hver regel kan inneholde et navn og én enkelt IP-adresse, et IP-adresseområde eller en CIDR IP-adresse. Maksimalt 256 regler kan angis per arbeidsområde.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK		Forespørselen ble fullført og har ikke noe innhold i svarteksten. Overskrifter: Etag`string` – Den nye ETag for brannmurkonfigurasjonen etter oppdateringen. Bruk denne verdien i overskriften for et etterfølgende PUT-anrop `If-Match` til å bruke optimistisk samtidighetskontroll.
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 ble fullført og har ikke noe innhold i svarteksten.

Overskrifter:

Etagstring – Den nye ETag for brannmurkonfigurasjonen etter oppdateringen. Bruk denne verdien i overskriften for et etterfølgende PUT-anrop If-Match til å bruke optimistisk samtidighetskontroll.

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

Example for setting workspace firewall rules

Eksempelforespørsel

HTTP

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

{
  "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"
    }
  ]
}

Eksempelsvar

Statuskode:: 204

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

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
FirewallRule	Definerer en brannmurregel, identifisert av navnet og inneholder én enkelt IP-adresse, et IP-adresseområde eller en CIDR IP-adresse som verdi.
InboundFirewallConfiguration	Dette objektet definerer det fullstendige settet med brannmurregler for å administrere innkommende tilgangsbeskyttelse som en del av arbeidsområdets kommunikasjonspolicy for nettverk. Den sikrer at bare eksplisitt autoriserte IP-adresser er tillatt for innkommende kommunikasjon. Når det sendes via PUT-API-en, oppretter eller erstatter dette objektet den eksisterende IP-brannmurkonfigurasjonen for arbeidsområdet fullt ut. Disse reglene håndheves bare når arbeidsområdets nettverkskommunikasjonspolicy har inbound.publicAccessRules.defaultAction satt til Avslå.

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.

FirewallRule

Objekt

Definerer en brannmurregel, identifisert av navnet og inneholder én enkelt IP-adresse, et IP-adresseområde eller en CIDR IP-adresse som verdi.

Navn	Type	Beskrivelse
displayName	string	Angir navnet på regelen. Visningsnavn kan inneholde opptil 128 tegn og må være unike per arbeidsområde.
value	string	Angir verdien for regelen, angitt som én enkelt IP-adresse, et IP-adresseområde eller en CIDR IP-adresse.

InboundFirewallConfiguration

Objekt

Dette objektet definerer det fullstendige settet med brannmurregler for å administrere innkommende tilgangsbeskyttelse som en del av arbeidsområdets kommunikasjonspolicy for nettverk. Den sikrer at bare eksplisitt autoriserte IP-adresser er tillatt for innkommende kommunikasjon. Når det sendes via PUT-API-en, oppretter eller erstatter dette objektet den eksisterende IP-brannmurkonfigurasjonen for arbeidsområdet fullt ut. Disse reglene håndheves bare når arbeidsområdets nettverkskommunikasjonspolicy har inbound.publicAccessRules.defaultAction satt til Avslå.

Navn	Type	Beskrivelse
rules	FirewallRule[]	En liste over regler som definerer IP-adresser som er tillatt for innkommende tilgang. Hver regel kan inneholde et navn og én enkelt IP-adresse, et IP-adresseområde eller en CIDR IP-adresse. Maksimalt 256 regler kan angis per arbeidsområde.