Workspaces - Set Network Communication Policy

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Määrittää määritetyn työtilan verkkoviestintäkäytännön.
Tämä ohjelmointirajapinta käyttää PUT-menetelmää ja korvaa kaikki asetukset. Jos pyynnön leipätekstissä on vain osittainen käytäntö, jäljellä olevat asetukset määritetään oletusarvoihin. Kutsu aina ensin Nouda verkkoliikennekäytäntö -toimintoa ja anna pyynnön leipätekstissä koko käytäntö.

Muistio

Jos defaultAction jätetään pois pyynnön leipätekstistä, sen oletusarvo on Allow, joka voi tahattomasti avata saapuvan ja lähtevän verkon käytön. Määritä aina erikseen defaultAction jokaisessa PUT-pyynnön leipätekstissä.

Käyttöoikeudet

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

Vaaditut delegoidut vaikutusalueet

Workspace.ReadWrite.All

tuettujen käyttäjätietojen Microsoft Entra

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

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön otsikko

Nimi	Pakollinen	Tyyppi	Kuvaus
If-Match		string	ETag-arvo. ETag on määritettävä lainausmerkkeissä. Jos tämä on annettu, kutsu onnistuu vain, jos resurssin ETag-arvo vastaa annettua ETag-parametria.

Pyynnön leipäteksti

Nimi	Tyyppi	Kuvaus
inbound	InboundRules	Tämä on työtilan saapuvan verkon viestintäominaisuudet.
outbound	OutboundRules	Työtilan lähtevän verkon viestintäominaisuudet.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK		Pyynnön valmistuttua. Otsikot ETag: string
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.

Pyynnön valmistuttua.

Otsikot

ETag: string

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

Set workspace networking communication policy example

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 200

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

Määritelmät

Nimi	Kuvaus
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
InboundRules	Käytäntö kaikille työtilaan saapuville tiedonannuksille.
NetworkAccessRule	Oletuskäytäntö työtilan käyttämiselle julkisista verkoista. Jos PUT-pyynnön runko jätetään pois, tämän kentän oletusarvo on `Allow`, joka voi tahattomasti avata verkkoyhteyden. Määritä tämä kenttä aina erikseen jokaisessa PUT-pyynnön leipätekstissä.
NetworkRules	Käytäntö, joka määrittää pääsyn työtilaan tai julkisten verkkojen kautta tai julkisista verkoista.
OutboundRules	Käytäntö kaikelle työtilasta lähtevälle viestinnälle.
WorkspaceNetworkingCommunicationPolicy	Tämä on työtilan verkkoviestintäkäytäntö.

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.

InboundRules

Kohde

Käytäntö kaikille työtilaan saapuville tiedonannuksille.

Nimi	Tyyppi	Kuvaus
publicAccessRules	NetworkRules	Käytäntö, joka koskee julkisten verkkojen kautta työtilaan saapuvaa viestintää.

NetworkAccessRule

Luettelointi

Oletuskäytäntö työtilan käyttämiselle julkisista verkoista. Jos PUT-pyynnön runko jätetään pois, tämän kentän oletusarvo on Allow, joka voi tahattomasti avata verkkoyhteyden. Määritä tämä kenttä aina erikseen jokaisessa PUT-pyynnön leipätekstissä.

Arvo	Kuvaus
Allow	Salli kaikki yhteydet.
Deny	Estä kaikki yhteydet.

NetworkRules

Kohde

Käytäntö, joka määrittää pääsyn työtilaan tai julkisten verkkojen kautta tai julkisista verkoista.

Nimi	Tyyppi	Kuvaus
defaultAction	NetworkAccessRule	Oletuskäytäntö työtilan käyttämiselle julkisista verkoista. Jos PUT-pyynnön runko jätetään pois, tämän kentän oletusarvo on `Allow`, joka voi tahattomasti avata verkkoyhteyden. Määritä tämä kenttä aina erikseen jokaisessa PUT-pyynnön leipätekstissä.

OutboundRules

Kohde

Käytäntö kaikelle työtilasta lähtevälle viestinnälle.

Nimi	Tyyppi	Kuvaus
publicAccessRules	NetworkRules	Käytäntö, joka koskee lähtevää viestintää julkisiin verkkoihin työtilasta.

WorkspaceNetworkingCommunicationPolicy

Kohde

Tämä on työtilan verkkoviestintäkäytäntö.

Nimi	Tyyppi	Kuvaus
inbound	InboundRules	Tämä on työtilan saapuvan verkon viestintäominaisuudet.
outbound	OutboundRules	Työtilan lähtevän verkon viestintäominaisuudet.