Workspaces - Set Firewall Rules

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Määrittää työtilan IP-palomuurisäännöt. Tämän ohjelmointirajapinnan avulla työtilan järjestelmänvalvojat voivat määrittää IP-palomuurisääntöjä, jotka ohjaavat sitä, mitkä IP-osoitteet sallitaan työtilaan yhdistämiseen. Tämä ominaisuus on käytettävissä vain esiversiona.

Muistio

Tämä ohjelmointirajapinta on osa esikatseluversiota, ja se on saatavilla vain arviointi- ja kehitystarkoituksiin. Muutos saattaa perustua palautteeseen, eikä sitä suositella tuotantokäyttöön.

Muistio

Palomuurisääntöjä käytetään vain, jos työtilan verkkoviestintäkäytännön inbound.publicAccessRules.defaultAction-asetuksena on Hylkää. Jos julkista käyttöä ei ole estetty työtilassa, tämän työtilan API-kutsuja ei rajoiteta.

Muistio

Tämä ohjelmointirajapinta käyttää PUT-menetelmää ja korvaa kaikki työtilan IP-palomuurisäännöt. Suorita aina Hae ensin ja anna kaikki IP-palomuurisäännöt pyynnön runkoon.

Käyttöoikeudet

Soittajalla on oltava järjestelmänvalvojan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Käyttäjätiedot Tuki
Käyttäjä Yes
palvelun päänimen ja Hallittujen käyttäjätietojen Yes

Interface

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Kuvaus
workspaceId
 path True

string (uuid)

Päivitettävän työtilan yksilöllinen tunnus.

Pyynnön leipäteksti

Nimi Tyyppi Kuvaus
rules

FirewallRule[]

Luettelo säännöistä, jotka määrittävät saapuvan käytön sallitut IP-osoitteet. Jokainen sääntö voi sisältää nimen ja yksittäisen IP-osoitteen, IP-osoitealueen tai CIDR-IP-osoitteen. Kullekin työtilalle voidaan määrittää enintään 256 sääntöä.

Vastaukset

Nimi Tyyppi Kuvaus
200 OK

Pyyntö on suoritettu onnistuneesti, eikä vastauksen leipätekstissä ole sisältöä.

Otsikot:

Etagstring – Palomuurin määritysten uusi ETag päivityksen jälkeen. Käytä tätä arvoa myöhemmässä PUT-kutsun If-Match otsikossa optimistisen samanaikaisuuden hallinnan käyttämiseksi.
429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • UnknownError – Ilmeni virhe.

Esimerkit

Example for setting workspace firewall rules

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi Kuvaus
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
FirewallRule

Määrittää palomuurisäännön, joka tunnistetaan sen nimen perusteella ja joka sisältää yksittäisen IP-osoitteen, IP-osoitealueen tai CIDR-IP-osoitteen sen arvona.
InboundFirewallConfiguration

Tämä objekti määrittää koko palomuurisääntöjen joukon, joilla hallitaan saapuvan käytön suojausta osana työtilan verkkoviestintäkäytäntöä. Se varmistaa, että vain nimenomaisesti valtuutetut IP-osoitteet sallitaan saapuvaan tiedonsiirtoon. KUN objekti lähetetään PUT-ohjelmointirajapinnan kautta, se luo tai korvaa työtilan olemassa olevan IP-palomuurin määrityksen. Näitä sääntöjä käytetään vain, kun työtilan verkkoviestintäkäytännön inbound.publicAccessRules.defaultAction-asetuksena on Hylkää.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Kuvaus
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable

boolean

Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon Retry-After avulla, jos se on käytettävissä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

FirewallRule

Kohde

Määrittää palomuurisäännön, joka tunnistetaan sen nimen perusteella ja joka sisältää yksittäisen IP-osoitteen, IP-osoitealueen tai CIDR-IP-osoitteen sen arvona.

Nimi Tyyppi Kuvaus
displayName

string

Määrittää säännön nimen. Näyttönimet voivat olla enintään 128 merkkiä pitkiä, ja niiden on oltava yksilöllisiä jokaista työtilaa kohden.
value

string

Määrittää säännön arvon, joka on määritetty yksittäisenä IP-osoitteena, IP-osoitealueena tai CIDR-IP-osoitteena.

InboundFirewallConfiguration

Kohde

Tämä objekti määrittää koko palomuurisääntöjen joukon, joilla hallitaan saapuvan käytön suojausta osana työtilan verkkoviestintäkäytäntöä. Se varmistaa, että vain nimenomaisesti valtuutetut IP-osoitteet sallitaan saapuvaan tiedonsiirtoon. KUN objekti lähetetään PUT-ohjelmointirajapinnan kautta, se luo tai korvaa työtilan olemassa olevan IP-palomuurin määrityksen. Näitä sääntöjä käytetään vain, kun työtilan verkkoviestintäkäytännön inbound.publicAccessRules.defaultAction-asetuksena on Hylkää.

Nimi Tyyppi Kuvaus
rules

FirewallRule[]

Luettelo säännöistä, jotka määrittävät saapuvan käytön sallitut IP-osoitteet. Jokainen sääntö voi sisältää nimen ja yksittäisen IP-osoitteen, IP-osoitealueen tai CIDR-IP-osoitteen. Kullekin työtilalle voidaan määrittää enintään 256 sääntöä.