Workspaces - Set Outbound Cloud Connection Rules

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Määrittää lähtevien käyttöoikeuksien suojauksen pilviyhteyden säännöt työtilalle.
Tämän ohjelmointirajapinnan avulla työtilan järjestelmänvalvojat voivat määrittää kokoelman lähteviä verkkoviestintäsääntöjä, joilla määritetään, mitkä pilviyhteystyypit ja tarvittaessa heidän ulkoiset päätepisteet/työtilat sallitaan työtilasta.

Note

Lähtevän käytön suojaussääntöjä käytetään vain, jos työtilan verkkoviestintäkäytännön asetuksena Denyon outbound.publicAccessRules.defaultAction . Jos OAP ei ole käytössä työtilassa, ohjelmointirajapinta epäonnistuu, koska lähteviä yhteyksiä ei ole rajoitettu.

Note

Tämä ohjelmointirajapinta käyttää PUT-menetelmää ja korvaa kaikki työtilan lähtevät käyttöoikeusyhteydet. Kutsu aina hae lähtevän pilvipalvelun yhteyssäännöt -toimintoa ensin ja anna koko käytäntö pyynnön leipätekstissä.

Note

Jos defaultAction jätetään pois pyynnön leipätekstistä, sen oletusarvo on Allow, joka voi tahattomasti sallia kaikki lähtevät pilviyhteydet. 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.

Käyttäjätiedot	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/outbound/connections

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
defaultAction	ConnectionAccessActionType	Määrittää oletuskäyttäytymisen kaikille pilviyhteystyypeille, joita ei ole eksplisiittisesti lueteltu sääntömatriisissa. Jos asetuksena on "Salli", kaikki määrittämättömät yhteystyypit ovat oletusarvoisesti sallittuja. Jos asetuksena on "Hylkää", kaikki määrittämättömät yhteystyypit on oletusarvoisesti estetty, ellei sitä nimenomaisesti sallita. Tämä asetus toimii yleisenä varakäytäntönä, ja se on erittäin tärkeä suojatun oletustilan pakottamiselle ympäristöissä, joissa sallitaan vain tunnetut ja luotetut yhteydet. Jos PUT-pyynnön runko jätetään pois, tämän kentän oletusarvo on `Allow`, joka voi tahattomasti sallia kaikki lähtevät yhteydet. Määritä tämä kenttä aina erikseen jokaisessa PUT-pyynnön leipätekstissä.
rules	OutboundConnectionRule[]	Luettelo säännöistä, jotka määrittävät lähtevän käytön toiminnan tietyissä pilviyhteystyypeissä. Jokainen sääntö voi sisältää päätepistepohjaisia tai työtilaan perustuvia rajoituksia tuettujen yhteystyyppien mukaan.

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 outbound access protection cloud connection rule for example

Mallipyyntö

HTTP

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

{
  "defaultAction": "Deny",
  "rules": [
    {
      "connectionType": "SQL",
      "defaultAction": "Deny",
      "allowedEndpoints": [
        {
          "hostnamePattern": "*.microsoft.com"
        }
      ]
    },
    {
      "connectionType": "LakeHouse",
      "defaultAction": "Deny",
      "allowedWorkspaces": [
        {
          "workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
        }
      ]
    },
    {
      "connectionType": "Web",
      "defaultAction": "Allow"
    }
  ]
}

Mallivastaus

Tilakoodi:: 200

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

Määritelmät

Nimi	Kuvaus
ConnectionAccessActionType	Määrittää lähtevien yhteyksien käyttöoikeuksien valvonnan toiminnan. Tätä luettelointia käytetään kentän defaultAction-toiminnossa sen määrittämiseen, sallitaanko tai hylätäänkö lähtevä tietoliikenne oletusarvoisesti. Tämän tyypin avulla voidaan hallita sekä yleisiä että yhteyskohtaisia lähteviä käyttöoikeuksia, mikä auttaa toteuttamaan suojattuja ja ennustettavia verkkoviestintäkäytäntöjä. Muita yhteyden käytön toimintotyyppejä voidaan lisätä ajan mittaan.
ConnectionRuleEndpointMetadata	Edustaa yksittäistä päätepistetason poikkeussääntöä, joka sallii lähtevän tietoliikenteen tiettyyn ulkoiseen toimialueeseen tai isäntään. Tätä objektia käytetään yhteyssäännön allowedEndpoints-matriisissa eksplisiittisesti sallimaan tietyn yhteystyypin luotettujen päätepisteiden lähtevä käyttöoikeus. Tämä koskee vain yhteystyyppejä, jotka tukevat päätepistepohjaista suodatusta (esimerkiksi SQL, MySQL, Verkko jne.).
ConnectionRuleWorkspaceMetadata	Edustaa työtilatason poikkeussääntöä, joka sallii lähtevän tietoliikenteen tiettyyn työtilaan tietylle connectionType-tyypille. Tätä objektia käytetään yhteyssäännön sallitussaWorkspaces-matriisissa, jotta työtilojen välinen käyttö voidaan nimenomaisesti sallia. Tämä koskee vain yhteystyyppejä, jotka tukevat työtilaan perustuvaa suodatusta, kuten Lakehouse, Warehouse, FabricSql ja PowerPlatformDataflows.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
OutboundConnectionRule	Määrittää lähtevän käyttösäännön tietylle pilviyhteydelle.
WorkspaceOutboundConnections	Edustaa työtilaan määritettyjen lähtevien käyttöoikeuksien suojauksen pilviyhteyssääntöjen koko joukkoa osana sen verkkoviestintäkäytäntöä. Tämä objekti määrittää yhteyssäännöt, joilla hallitaan sitä, mitkä ulkoiset päätepisteet ja työtilat sallitaan tai hylätään lähtevässä tietoliikenneessä

ConnectionAccessActionType

Luettelointi

Määrittää lähtevien yhteyksien käyttöoikeuksien valvonnan toiminnan. Tätä luettelointia käytetään kentän defaultAction-toiminnossa sen määrittämiseen, sallitaanko tai hylätäänkö lähtevä tietoliikenne oletusarvoisesti. Tämän tyypin avulla voidaan hallita sekä yleisiä että yhteyskohtaisia lähteviä käyttöoikeuksia, mikä auttaa toteuttamaan suojattuja ja ennustettavia verkkoviestintäkäytäntöjä. Muita yhteyden käytön toimintotyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Allow	Sallii lähtevät yhteydet. Kun sitä käytetään oletustoimintona, kaikki pilviyhteydet sallitaan.
Deny	Estää lähtevät yhteydet. Kun sitä käytetään oletustoimintona, kaikki pilviyhteydet hylätään, ellei sitä nimenomaisesti sallita.

ConnectionRuleEndpointMetadata

Kohde

Edustaa yksittäistä päätepistetason poikkeussääntöä, joka sallii lähtevän tietoliikenteen tiettyyn ulkoiseen toimialueeseen tai isäntään. Tätä objektia käytetään yhteyssäännön allowedEndpoints-matriisissa eksplisiittisesti sallimaan tietyn yhteystyypin luotettujen päätepisteiden lähtevä käyttöoikeus. Tämä koskee vain yhteystyyppejä, jotka tukevat päätepistepohjaista suodatusta (esimerkiksi SQL, MySQL, Verkko jne.).

Nimi	Tyyppi	Kuvaus
hostnamePattern	string	Yleismerkki tuettu malli, joka määrittää sallitun ulkoisen päätepisteen. Esimerkkejä ovat *.microsoft.com, api.contoso.com tai data.partner.org.

ConnectionRuleWorkspaceMetadata

Kohde

Edustaa työtilatason poikkeussääntöä, joka sallii lähtevän tietoliikenteen tiettyyn työtilaan tietylle connectionType-tyypille. Tätä objektia käytetään yhteyssäännön sallitussaWorkspaces-matriisissa, jotta työtilojen välinen käyttö voidaan nimenomaisesti sallia. Tämä koskee vain yhteystyyppejä, jotka tukevat työtilaan perustuvaa suodatusta, kuten Lakehouse, Warehouse, FabricSql ja PowerPlatformDataflows.

Nimi	Tyyppi	Kuvaus
workspaceId	string (uuid)	Sen kohdetyötilan yksilöllinen tunnus (GUID), jonka saa muodostaa yhteys nykyiseen työtilaan.

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.

OutboundConnectionRule

Kohde

Määrittää lähtevän käyttösäännön tietylle pilviyhteydelle.

Nimi	Tyyppi	Kuvaus
allowedEndpoints	ConnectionRuleEndpointMetadata[]	Määrittää eksplisiittisesti sallittujen ulkoisten päätepisteiden luettelon connectionType-funktiolle. Matriisin jokainen merkintä edustaa isäntänimimallia, joka sallitaan lähtevälle tietoliikenneelle työtilasta. Tämä kenttä on käytettävissä vain yhteystyypeille, jotka tukevat päätepistepohjaista suodatusta (esimerkiksi SQL, MySQL, Verkko jne.). Jos defaultAction-asetuksena on yhteystyypin "Hylkää", vain tässä luetellut päätepisteet sallitaan. kaikki muut estetään.
allowedWorkspaces	ConnectionRuleWorkspaceMetadata[]	Määrittää luettelon työtilan tunnuksista, jotka ovat eksplisiittisesti sallittuja lähtevän tietoliikenteen yhteydessä kyseiselle fabric connectionType -tyypille. Tätä kenttää käytetään vain kangasyhteystyyppeihin, jotka tukevat työtilaan perustuvaa suodatusta( rajoitettu Lakehouse-, Warehouse-, FabricSql- ja PowerPlatformDataflows-taulukoihin). Kun oletusasetuksena on Yhteystyypin estäminen, vain sallituissa Työtilat-kohdassa luetellut työtilat sallitaan lähteville käyttöoikeuksille. kaikki muut estetään.
connectionType	string	Määrittää pilviyhteyden tyypin, jota sääntö koskee. Muiden sääntö-ominaisuuksien (kuten sallittujenEndpoints-ominaisuuksien tai sallittujen Työtilat) toiminta ja sovellettavuus voivat vaihdella yhteystyypin ominaisuuksien mukaan.
defaultAction	ConnectionAccessActionType	Määrittää lähtevän käytön oletustoiminnot connectionType-funktiolle. Tämä kenttä määrittää, ovatko tämän tyypin yhteydet sallittuja vai estettyjä oletusarvoisesti, ellei asetusta allowedEndpoints tai allowedWorkspaces tarkenneta tarkemmin. Jos asetuksena on "Salli": Kaikki tämäntyyppiset yhteydet ovat sallittuja, ellei tarkempaa sääntöä nimenomaisesti kielletä. Tämä kenttä tarjoaa tarkat hallintatoiminnot kullekin yhteystyypille ja täydentää oletusarvoisesti määritettyä yleistä varatoimintaa.

WorkspaceOutboundConnections

Kohde

Edustaa työtilaan määritettyjen lähtevien käyttöoikeuksien suojauksen pilviyhteyssääntöjen koko joukkoa osana sen verkkoviestintäkäytäntöä. Tämä objekti määrittää yhteyssäännöt, joilla hallitaan sitä, mitkä ulkoiset päätepisteet ja työtilat sallitaan tai hylätään lähtevässä tietoliikenneessä

Nimi	Tyyppi	Kuvaus
defaultAction	ConnectionAccessActionType	Määrittää oletuskäyttäytymisen kaikille pilviyhteystyypeille, joita ei ole eksplisiittisesti lueteltu sääntömatriisissa. Jos asetuksena on "Salli", kaikki määrittämättömät yhteystyypit ovat oletusarvoisesti sallittuja. Jos asetuksena on "Hylkää", kaikki määrittämättömät yhteystyypit on oletusarvoisesti estetty, ellei sitä nimenomaisesti sallita. Tämä asetus toimii yleisenä varakäytäntönä, ja se on erittäin tärkeä suojatun oletustilan pakottamiselle ympäristöissä, joissa sallitaan vain tunnetut ja luotetut yhteydet. Jos PUT-pyynnön runko jätetään pois, tämän kentän oletusarvo on `Allow`, joka voi tahattomasti sallia kaikki lähtevät yhteydet. Määritä tämä kenttä aina erikseen jokaisessa PUT-pyynnön leipätekstissä.
rules	OutboundConnectionRule[]	Luettelo säännöistä, jotka määrittävät lähtevän käytön toiminnan tietyissä pilviyhteystyypeissä. Jokainen sääntö voi sisältää päätepistepohjaisia tai työtilaan perustuvia rajoituksia tuettujen yhteystyyppien mukaan.