Workspaces - Get Outbound Gateway Rules

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Palauttaa lähtevän käytön suojauksen (OAP) käytössä olevan työtilan yhdyskäytäväsäännöt.
Tämän ohjelmointirajapinnan avulla työtilan järjestelmänvalvojat voivat tarkastella käytössä olevia lähteviä verkkoviestintäkäytäntöjä, joita käytetään paikallisissa ja VNet-tietoyhdyskäytävissä. Yhdyskäytäväsäännöt palautetaan ja otetaan käyttöön vain, jos työtilan verkkoviestintäkäytännön asetuksena outbound.publicAccessRules.defaultActionon Deny . Jos OAP ei ole käytössä työtilassa, ohjelmointirajapinta epäonnistuu, koska lähteviä yhteyksiä ei rajoiteta.

Käyttöoikeudet

Kutsujalla on oltava katselijan tai suurempi työtilarooli.

Vaaditut delegoidut vaikutusalueet

Workspace.Read.All tai 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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/outbound/gateways

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Kuvaus
workspaceId
 path True

string (uuid)

Sen työtilan yksilöllinen tunnus, jonka lähtevistä säännöistä tehdään kyselyjä.

Vastaukset

Nimi Tyyppi Kuvaus
200 OK

WorkspaceOutboundGateways

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

Get workspace outbound access protection gateway rule for example

Mallipyyntö

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

Mallivastaus

Tilakoodi:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    }
  ]
}

Määritelmät

Nimi Kuvaus
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
GatewayAccessActionType

Määrittää lähtevien yhdyskäytävien 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ä tyyppi mahdollistaa sekä yleisen että yhdyskäytäväkohtaisen lähtevän käytön hallinnan, mikä auttaa toteuttamaan suojattuja ja ennustettavia verkkoviestintäkäytäntöjä. Muita yhdyskäytävän käyttöoikeuksien toimintotyyppejä voidaan lisätä ajan mittaan.
GatewayAccessRuleMetadata

Edustaa yhdyskäytävää, joka sallitaan lähtevää tietoliikennetta varten. Objektia käytetään sallitunGateways-kohteen sisällä, jotta lähtevä käyttö voidaan nimenomaisesti sallia.
WorkspaceOutboundGateways

Edustaa työtilan verkkoviestintäkäytännön osana määritettyjä lähtevien käyttöoikeuksien suojaussääntöjen koko joukkoa. Tämä objekti määrittää yhdyskäytäväsäännöt, jotka ohjaavat lähtevää tietoliikennettä

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.

GatewayAccessActionType

Luettelointi

Määrittää lähtevien yhdyskäytävien 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ä tyyppi mahdollistaa sekä yleisen että yhdyskäytäväkohtaisen lähtevän käytön hallinnan, mikä auttaa toteuttamaan suojattuja ja ennustettavia verkkoviestintäkäytäntöjä. Muita yhdyskäytävän käyttöoikeuksien toimintotyyppejä voidaan lisätä ajan mittaan.

Arvo Kuvaus
Allow

Sallii lähtevät yhdyskäytävät. Kaikki yhdyskäytävät sallitaan, kun niitä käytetään oletustoimintona.
Deny

Estää lähteviä yhdyskäytäviä. Kun sitä käytetään oletustoimintona, kaikki yhdyskäytävät hylätään, ellei sitä nimenomaisesti sallita.

GatewayAccessRuleMetadata

Kohde

Edustaa yhdyskäytävää, joka sallitaan lähtevää tietoliikennetta varten. Objektia käytetään sallitunGateways-kohteen sisällä, jotta lähtevä käyttö voidaan nimenomaisesti sallia.

Nimi Tyyppi Kuvaus
id

string (uuid)

Yhdyskäytävän tunnus sallitaan.

WorkspaceOutboundGateways

Kohde

Edustaa työtilan verkkoviestintäkäytännön osana määritettyjä lähtevien käyttöoikeuksien suojaussääntöjen koko joukkoa. Tämä objekti määrittää yhdyskäytäväsäännöt, jotka ohjaavat lähtevää tietoliikennettä

Nimi Tyyppi Kuvaus
allowedGateways

GatewayAccessRuleMetadata[]

Luettelo säännöistä, jotka määrittävät yhdyskäytävien lähtevän käytön toiminnan.
defaultAction

GatewayAccessActionType

Määrittää oletustoiminnon kaikille yhdyskäytäville, joita ei ole eksplisiittisesti lueteltu sallitussa luettelomatriisissa. Jos asetuksena on "Salli", kaikki määrittämättömät yhdyskäytävät ovat oletusarvoisesti sallittuja. Jos arvoksi on määritetty Estä, kaikki määrittämättömät yhdyskäytävät estetään. 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 yhdyskäytäväyhteydet. Määritä tämä kenttä aina erikseen jokaisessa PUT-pyynnön leipätekstissä.