Workspaces - Set Firewall Rules

Tjeneste:: Core

API-version:: v1

Angiver IP-firewallreglerne for arbejdsområdet. Denne API gør det muligt for arbejdsområdeadministratorer at angive IP-firewallregler, der styrer, hvilke IP-adresser der skal have tilladelse til at oprette forbindelse til arbejdsområdet. Denne funktion findes i øjeblikket kun som prøveversion.

Bemærkning

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Bemærkning

Firewallregler gennemtvinges kun, hvis arbejdsområdets politik for netværkskommunikation har inbound.publicAccessRules.defaultAction angivet til Afvis. Hvis offentlig adgang ikke er blokeret i arbejdsområdet, begrænses API-kald til dette arbejdsområde ikke.

Bemærkning

Denne API bruger METODEN PUT og overskriver alle IP-firewallregler for arbejdsområdet. Kør altid Hent først, og angiv alle IP-firewallregler i anmodningens brødtekst.

Tilladelser

Kalderen skal have administrator arbejdsområderolle.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Interface

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Entydigt id for det arbejdsområde, der skal opdateres.

Brødtekst for anmodning

Name	Type	Beskrivelse
rules	FirewallRule[]	En liste over regler, der definerer IP-adresser, der er tilladt for indgående adgang. Hver regel kan indeholde et navn og en enkelt IP-adresse, et IP-adresseområde eller en CIDR-IP-adresse. Der kan maksimalt angives 256 regler pr. arbejdsområde.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK		Anmodningen blev fuldført og har intet indhold i svarteksten. Overskrifter: Etag`string` – Den nye ETag for firewallkonfigurationen efter opdateringen. Brug denne værdi i overskriften for et efterfølgende PUT-kald `If-Match` til at anvende optimistisk samtidighedskontrol.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

Anmodningen blev fuldført og har intet indhold i svarteksten.

Overskrifter:

Etagstring – Den nye ETag for firewallkonfigurationen efter opdateringen. Brug denne værdi i overskriften for et efterfølgende PUT-kald If-Match til at anvende optimistisk samtidighedskontrol.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Example for setting workspace firewall rules

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
FirewallRule	Definerer en firewallregel, der identificeres ved navn og indeholder en enkelt IP-adresse, et IP-adresseområde eller en CIDR-IP-adresse som dens værdi.
InboundFirewallConfiguration	Dette objekt definerer det komplette sæt firewallregler til administration af beskyttelse mod indgående adgang som en del af et arbejdsområdes politik for netværkskommunikation. Det sikrer, at kun eksplicit godkendte IP-adresser er tilladt til indgående kommunikation. Når objektet sendes via PUT-API'en, oprettes eller erstattes den eksisterende KONFIGURATION af IP-firewallen for arbejdsområdet fuldt ud. Disse regler gennemtvinges kun, når arbejdsområdets politik for netværkskommunikation har inbound.publicAccessRules.defaultAction angivet til Afvis.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

FirewallRule

Objekt

Definerer en firewallregel, der identificeres ved navn og indeholder en enkelt IP-adresse, et IP-adresseområde eller en CIDR-IP-adresse som dens værdi.

Name	Type	Beskrivelse
displayName	string	Angiver navnet på reglen. Visningsnavne kan være op til 128 tegn lange og skal være entydige pr. arbejdsområde.
value	string	Angiver værdien af reglen, der er angivet som en enkelt IP-adresse, et IP-adresseområde eller en CIDR-IP-adresse.

InboundFirewallConfiguration

Objekt

Dette objekt definerer det komplette sæt firewallregler til administration af beskyttelse mod indgående adgang som en del af et arbejdsområdes politik for netværkskommunikation. Det sikrer, at kun eksplicit godkendte IP-adresser er tilladt til indgående kommunikation. Når objektet sendes via PUT-API'en, oprettes eller erstattes den eksisterende KONFIGURATION af IP-firewallen for arbejdsområdet fuldt ud. Disse regler gennemtvinges kun, når arbejdsområdets politik for netværkskommunikation har inbound.publicAccessRules.defaultAction angivet til Afvis.

Name	Type	Beskrivelse
rules	FirewallRule[]	En liste over regler, der definerer IP-adresser, der er tilladt for indgående adgang. Hver regel kan indeholde et navn og en enkelt IP-adresse, et IP-adresseområde eller en CIDR-IP-adresse. Der kan maksimalt angives 256 regler pr. arbejdsområde.