Workspaces - Set Outbound Cloud Connection Rules

Tjeneste:
Core
API-versjon:
v1

Angir de utgående tilgangsbeskyttelsesreglene for skytilkobling for arbeidsområdet.
Denne API-en gjør det mulig for administratorer for arbeidsområder å angi en samling av utgående nettverkskommunikasjonsregler som styrer hvilke skytilkoblingstyper, og der det er aktuelt, tillates de eksterne endepunktene/arbeidsområdene fra arbeidsområdet.

Note

Beskyttelsesregler for utgående tilgang håndheves bare hvis arbeidsområdets nettverkskommunikasjonspolicy er outbound.publicAccessRules.defaultAction satt til Deny. Hvis OAP ikke er aktivert på arbeidsområdet, mislykkes API-en fordi utgående tilkoblinger ikke er begrenset.

Note

Denne API-en bruker PUT-metoden og overskriver alle utgående tilgangstilkoblinger for arbeidsområdet. Kall alltid operasjonen Hent utgående skytilkoblingsregler først, og oppgi hele policyen i forespørselsteksten.

Note

Hvis defaultAction den utelates fra forespørselsteksten Allow, vil den som standard tillate alle utgående skytilkoblinger utilsiktet. Angi alltid eksplisitt defaultAction i hver PUT-forespørselstekst.

Tillatelser

Innringeren må ha administrator arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Støtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

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

URI-parametere

Name I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Unik identifikator for arbeidsområdet som skal oppdateres.

Brødtekst for forespørsel

Name Type Beskrivelse
defaultAction

ConnectionAccessActionType

Definerer standard virkemåte for alle skytilkoblingstyper som ikke er eksplisitt oppført i regelmatrisen. Hvis angitt til «Tillat», tillates alle uspesifiserte tilkoblingstyper som standard. Hvis satt til «Avslå», blokkeres alle uspesifiserte tilkoblingstyper som standard, med mindre det er uttrykkelig tillatt. Denne innstillingen fungerer som en global tilbakefallspolicy og er avgjørende for å håndheve en sikker standardstilling i miljøer der bare kjente og klarerte tilkoblinger bør tillates. Hvis det utelates fra en PUT-forespørselstekst, er dette feltet standard for Allow, noe som utilsiktet kan tillate alle utgående tilkoblinger. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.
rules

OutboundConnectionRule[]

En liste over regler som definerer utgående tilgangsvirkemåte for bestemte skytilkoblingstyper. Hver regel kan inneholde endepunktbaserte eller arbeidsområdebaserte begrensninger avhengig av støttede tilkoblingstyper.

Svar

Name Type Beskrivelse
200 OK

Forespørselen er fullført.

Overskrifter

ETag: string
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • UnknownError - Det oppstod en feil.

Eksempler

Set workspace outbound access protection cloud connection rule for example

Eksempelforespørsel

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

Eksempelsvar

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

Definisjoner

Name Beskrivelse
ConnectionAccessActionType

Definerer virkemåten for tilgangskontroll for utgående tilkoblinger. Denne opplistingen brukes for feltet defaultAction til å angi om utgående kommunikasjon skal tillates eller nektes som standard. Denne typen muliggjør både global og tilkoblingsspesifikk kontroll over utgående tilgang, noe som bidrar til å håndheve sikre og forutsigbare nettverkskommunikasjonspolicyer. Flere handlingstyper for tilkoblingstilgang kan legges til over tid.
ConnectionRuleEndpointMetadata

Representerer en enkelt unntaksregel på endepunktnivå som tillater utgående kommunikasjon til et bestemt eksternt domene eller en vert. Dette objektet brukes i allowedEndpoints-matrisen i en tilkoblingsregel til eksplisitt å godkjenne utgående tilgang til klarerte endepunkter for en gitt connectionType. Dette gjelder bare for tilkoblingstyper som støtter endepunktbasert filtrering (for eksempel SQL, MySQL, Web osv.).
ConnectionRuleWorkspaceMetadata

Representerer en unntaksregel på arbeidsområdenivå som tillater utgående kommunikasjon til et bestemt arbeidsområde for en gitt connectionType. Dette objektet brukes i allowedWorkspaces-matrisen i en tilkoblingsregel for eksplisitt godkjenning av tilgang på tvers av arbeidsområder. Dette gjelder bare for tilkoblingstyper som støtter arbeidsområdebasert filtrering, for eksempel Lakehouse, Warehouse, FabricSql og PowerPlatformDataflows.
ErrorParameter

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
OutboundConnectionRule

Definerer en utgående tilgangsregel for en bestemt skytilkobling.
WorkspaceOutboundConnections

Representerer det fullstendige settet med skytilkoblingsregler for utgående tilgangsbeskyttelse som er konfigurert for et arbeidsområde som en del av kommunikasjonspolicyen for nettverk. Dette objektet definerer tilkoblingsreglene som styrer hvilke eksterne endepunkter og arbeidsområder som er tillatt eller nektet for utgående kommunikasjon

ConnectionAccessActionType

Opplisting

Definerer virkemåten for tilgangskontroll for utgående tilkoblinger. Denne opplistingen brukes for feltet defaultAction til å angi om utgående kommunikasjon skal tillates eller nektes som standard. Denne typen muliggjør både global og tilkoblingsspesifikk kontroll over utgående tilgang, noe som bidrar til å håndheve sikre og forutsigbare nettverkskommunikasjonspolicyer. Flere handlingstyper for tilkoblingstilgang kan legges til over tid.

Verdi Beskrivelse
Allow

Tillater utgående tilkoblinger. Når de brukes som standardhandling, tillates alle skytilkoblinger.
Deny

Blokkerer utgående tilkoblinger. Når de brukes som standardhandling, nektes alle skytilkoblinger med mindre det er eksplisitt tillatt.

ConnectionRuleEndpointMetadata

Objekt

Representerer en enkelt unntaksregel på endepunktnivå som tillater utgående kommunikasjon til et bestemt eksternt domene eller en vert. Dette objektet brukes i allowedEndpoints-matrisen i en tilkoblingsregel til eksplisitt å godkjenne utgående tilgang til klarerte endepunkter for en gitt connectionType. Dette gjelder bare for tilkoblingstyper som støtter endepunktbasert filtrering (for eksempel SQL, MySQL, Web osv.).

Name Type Beskrivelse
hostnamePattern

string

Et jokertegn-støttet mønster som definerer det tillatte eksterne endepunktet. Eksempler inkluderer *.microsoft.com, api.contoso.com eller data.partner.org.

ConnectionRuleWorkspaceMetadata

Objekt

Representerer en unntaksregel på arbeidsområdenivå som tillater utgående kommunikasjon til et bestemt arbeidsområde for en gitt connectionType. Dette objektet brukes i allowedWorkspaces-matrisen i en tilkoblingsregel for eksplisitt godkjenning av tilgang på tvers av arbeidsområder. Dette gjelder bare for tilkoblingstyper som støtter arbeidsområdebasert filtrering, for eksempel Lakehouse, Warehouse, FabricSql og PowerPlatformDataflows.

Name Type Beskrivelse
workspaceId

string (uuid)

Den unike identifikatoren (GUID) for målarbeidsområdet som kan kobles fra gjeldende arbeidsområde.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name Type Beskrivelse
message

string

En lesbar beskrivelse av parameterens betydning.
name

string

Parameteridentifikatoren.
value

string

Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

OutboundConnectionRule

Objekt

Definerer en utgående tilgangsregel for en bestemt skytilkobling.

Name Type Beskrivelse
allowedEndpoints

ConnectionRuleEndpointMetadata[]

Definerer en liste over eksplisitt tillatte eksterne endepunkter for connectionType. Hver oppføring i matrisen representerer et vertsnavnmønster som er tillatt for utgående kommunikasjon fra arbeidsområdet. Dette feltet gjelder bare for tilkoblingstyper som støtter endepunktbasert filtrering (for eksempel SQL, MySQL, Web osv.). Hvis defaultAction er satt til «Nekt» for tilkoblingstypen, tillates bare endepunktene som er oppført her. alle andre vil bli blokkert.
allowedWorkspaces

ConnectionRuleWorkspaceMetadata[]

Angir en liste over arbeidsområde-ID-er som er eksplisitt tillatt for utgående kommunikasjon for den angitte stofftilkoblingstypen. Dette feltet gjelder bare for stofftilkoblingstyper som støtter arbeidsområdebasert filtrering, begrenset til Lakehouse, Warehouse, FabricSql og PowerPlatformDataflows. Når defaultAction er satt til «Nekt» for en tilkoblingstype, er det bare arbeidsområdene som er oppført i allowedWorkspaces, som tillater utgående tilgang. alle andre vil bli blokkert.
connectionType

string

Angir den skybaserte tilkoblingstypen som regelen gjelder for. Virkemåten og anvendeligheten til andre regelegenskaper (for eksempel allowedEndpoints eller allowedWorkspaces) kan variere avhengig av egenskapene til tilkoblingstypen.
defaultAction

ConnectionAccessActionType

Definerer standard virkemåte for utgående tilgang for connectionType. Dette feltet bestemmer om tilkoblinger av denne typen er tillatt eller blokkert som standard, med mindre ytterligere presiseres av allowedEndpoints eller allowedWorkspaces. Hvis angitt til «Tillat»: Alle tilkoblinger av denne typen er tillatt med mindre eksplisitt nektes av en mer spesifikk regel. Dette feltet gir finjustert kontroll over hver tilkoblingstype og utfyller den globale tilbakefallsvirkemåten definert som standardAction.

WorkspaceOutboundConnections

Objekt

Representerer det fullstendige settet med skytilkoblingsregler for utgående tilgangsbeskyttelse som er konfigurert for et arbeidsområde som en del av kommunikasjonspolicyen for nettverk. Dette objektet definerer tilkoblingsreglene som styrer hvilke eksterne endepunkter og arbeidsområder som er tillatt eller nektet for utgående kommunikasjon

Name Type Beskrivelse
defaultAction

ConnectionAccessActionType

Definerer standard virkemåte for alle skytilkoblingstyper som ikke er eksplisitt oppført i regelmatrisen. Hvis angitt til «Tillat», tillates alle uspesifiserte tilkoblingstyper som standard. Hvis satt til «Avslå», blokkeres alle uspesifiserte tilkoblingstyper som standard, med mindre det er uttrykkelig tillatt. Denne innstillingen fungerer som en global tilbakefallspolicy og er avgjørende for å håndheve en sikker standardstilling i miljøer der bare kjente og klarerte tilkoblinger bør tillates. Hvis det utelates fra en PUT-forespørselstekst, er dette feltet standard for Allow, noe som utilsiktet kan tillate alle utgående tilkoblinger. Angi alltid eksplisitt dette feltet i hver PUT-forespørselstekst.
rules

OutboundConnectionRule[]

En liste over regler som definerer utgående tilgangsvirkemåte for bestemte skytilkoblingstyper. Hver regel kan inneholde endepunktbaserte eller arbeidsområdebaserte begrensninger avhengig av støttede tilkoblingstyper.