Workspaces - Get Outbound Cloud Connection Rules

Tjeneste:: Core

API-version:: v1

Returnerer reglerne for cloudforbindelsen for arbejdsområdet, der er aktiveret med udgående adgangsbeskyttelse (OAP). Denne API er udviklet til at hjælpe administratorer af arbejdsområder med at få vist de effektive politikker for udgående netværkskommunikation, der gennemtvinges for cloudforbindelser. Regler for cloudforbindelse til udgående adgangsbeskyttelse returneres og anvendes kun, hvis arbejdsområdets politik for netværkskommunikation er outbound.publicAccessRules.defaultAction angivet til Afvis. Hvis OAP ikke er aktiveret i arbejdsområdet, mislykkes API'en, da udgående forbindelser ikke begrænses. Denne funktion findes i øjeblikket kun som prøveversion.

Notat

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Tilladelser

Den, der ringer op, skal have seer eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Entydigt id for det arbejdsområde, hvis udgående regler forespørges.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	WorkspaceOutboundConnections	Anmodningen blev fuldført. Headere ETag: string
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

WorkspaceOutboundConnections

Anmodningen blev fuldført.

Headere

ETag: string

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Get workspace outbound access protection cloud connection rule for example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:: 200

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

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

Definitioner

Name	Beskrivelse
ConnectionAccessActionType	Definerer funktionsmåden for adgangskontrol for udgående forbindelser. Denne optælling bruges til feltet defaultAction til at angive, om udgående kommunikation som standard skal tillades eller afvises. Denne type muliggør både global og forbindelsesspecifik kontrol over udgående adgang, hvilket hjælper med at gennemtvinge sikre og forudsigelige politikker for netværkskommunikation. Der kan tilføjes flere handlingstyper for forbindelsesadgang over tid.
ConnectionRuleEndpointMetadata	Repræsenterer en undtagelsesregel på enkelt slutpunktsniveau, der tillader udgående kommunikation til et bestemt eksternt domæne eller en bestemt vært. Dette objekt bruges i matrixen allowedEndpoints for en forbindelsesregel til eksplicit at godkende udgående adgang til slutpunkter, der er tillid til, for en given connectionType. Dette gælder kun for forbindelsestyper, der understøtter slutpunktsbaseret filtrering (f.eks. SQL, MySQL, Web osv.).
ConnectionRuleWorkspaceMetadata	Repræsenterer en undtagelsesregel på arbejdsområdeniveau, der tillader udgående kommunikation til et bestemt arbejdsområde for en given connectionType. Dette objekt bruges i matrixen allowedWorkspaces for en forbindelsesregel til eksplicit at godkende adgang på tværs af arbejdsområder. Dette gælder kun for forbindelsestyper, der understøtter arbejdsområdebaseret filtrering, f.eks. Lakehouse, Warehouse, FabricSql og PowerPlatformDataflows.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
OutboundConnectionRule	Definerer en udgående adgangsregel for en bestemt cloudforbindelse.
WorkspaceOutboundConnections	Repræsenterer det komplette sæt regler for cloudforbindelse til udgående adgangsbeskyttelse, der er konfigureret for et arbejdsområde som en del af dets politik for netværkskommunikation. Dette objekt definerer de forbindelsesregler, der styrer, hvilke eksterne slutpunkter og arbejdsområder der tillades eller afvises for udgående kommunikation

ConnectionAccessActionType

Optælling

Definerer funktionsmåden for adgangskontrol for udgående forbindelser. Denne optælling bruges til feltet defaultAction til at angive, om udgående kommunikation som standard skal tillades eller afvises. Denne type muliggør både global og forbindelsesspecifik kontrol over udgående adgang, hvilket hjælper med at gennemtvinge sikre og forudsigelige politikker for netværkskommunikation. Der kan tilføjes flere handlingstyper for forbindelsesadgang over tid.

Værdi	Beskrivelse
Allow	Tillader udgående forbindelser. Når den bruges som standardhandling, er alle cloudforbindelser tilladt.
Deny	Blokerer udgående forbindelser. Når den bruges som standardhandling, afvises alle cloudforbindelser, medmindre det udtrykkeligt er tilladt.

ConnectionRuleEndpointMetadata

Objekt

Repræsenterer en undtagelsesregel på enkelt slutpunktsniveau, der tillader udgående kommunikation til et bestemt eksternt domæne eller en bestemt vært. Dette objekt bruges i matrixen allowedEndpoints for en forbindelsesregel til eksplicit at godkende udgående adgang til slutpunkter, der er tillid til, for en given connectionType. Dette gælder kun for forbindelsestyper, der understøtter slutpunktsbaseret filtrering (f.eks. SQL, MySQL, Web osv.).

Name	Type	Beskrivelse
hostNamePattern	string	Et mønster, der understøttes af jokertegn, som definerer det tilladte eksterne slutpunkt. Eksempler omfatter *.microsoft.com, api.contoso.com eller data.partner.org.

ConnectionRuleWorkspaceMetadata

Objekt

Repræsenterer en undtagelsesregel på arbejdsområdeniveau, der tillader udgående kommunikation til et bestemt arbejdsområde for en given connectionType. Dette objekt bruges i matrixen allowedWorkspaces for en forbindelsesregel til eksplicit at godkende adgang på tværs af arbejdsområder. Dette gælder kun for forbindelsestyper, der understøtter arbejdsområdebaseret filtrering, f.eks. Lakehouse, Warehouse, FabricSql og PowerPlatformDataflows.

Name	Type	Beskrivelse
workspaceId	string (uuid)	Det entydige id (GUID) for det destinationsarbejdsområde, der må have forbindelse fra det aktuelle arbejdsområde.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

OutboundConnectionRule

Objekt

Definerer en udgående adgangsregel for en bestemt cloudforbindelse.

Name	Type	Beskrivelse
allowedEndpoints	ConnectionRuleEndpointMetadata[]	Definerer en liste over eksplicit tilladte eksterne slutpunkter for connectionType. Hver post i matrixen repræsenterer et værtsnavnmønster, der er tilladt for udgående kommunikation fra arbejdsområdet. Dette felt gælder kun for forbindelsestyper, der understøtter slutpunktsbaseret filtrering (f.eks. SQL, MySQL, Web osv.). Hvis defaultAction er angivet til "Afvis" for forbindelsestypen, er det kun de slutpunkter, der er angivet her, der er tilladt. alle andre vil blive blokeret.
allowedWorkspaces	ConnectionRuleWorkspaceMetadata[]	Angiver en liste over arbejdsområde-id'er, der udtrykkeligt er tilladt til udgående kommunikation for den angivne fabric connectionType. Dette felt gælder kun for stofforbindelsestyper, der understøtter arbejdsområdebaseret filtrering, begrænset til Lakehouse, Warehouse, FabricSql og PowerPlatformDataflows. Når defaultAction er angivet til "Afvis" for en forbindelsestype, er det kun de arbejdsområder, der er angivet i tilladte arbejdsområder, der er tilladt for udgående adgang. alle andre vil blive blokeret.
connectionType	string	Angiver den cloudforbindelsestype, som reglen gælder for. Funktionsmåden og anvendeligheden af andre regelegenskaber (f.eks. allowedEndpoints eller allowedWorkspaces) kan variere afhængigt af egenskaberne for forbindelsestypen.
defaultAction	ConnectionAccessActionType	Definerer standardfunktionsmåden for udgående adgang for connectionType. Dette felt bestemmer, om forbindelser af denne type er tilladt eller blokeret som standard, medmindre de er yderligere afgrænset af allowedEndpoints eller allowedWorkspaces. Hvis den er angivet til "Tillad": Alle forbindelser af denne type er tilladt, medmindre de udtrykkeligt afvises af en mere specifik regel. Dette felt giver detaljeret kontrol over hver forbindelsestype og supplerer den globale fallback-funktionsmåde, der er defineret af defaultAction.

WorkspaceOutboundConnections

Objekt

Repræsenterer det komplette sæt regler for cloudforbindelse til udgående adgangsbeskyttelse, der er konfigureret for et arbejdsområde som en del af dets politik for netværkskommunikation. Dette objekt definerer de forbindelsesregler, der styrer, hvilke eksterne slutpunkter og arbejdsområder der tillades eller afvises for udgående kommunikation

Name	Type	Beskrivelse
defaultAction	ConnectionAccessActionType	Definerer standardfunktionsmåden for alle cloudforbindelsestyper, der ikke eksplicit er angivet i regelmatrixen. Hvis indstillingen er angivet til "Tillad", tillades alle ikke-angivne forbindelsestyper som standard. Hvis indstillingen er angivet til "Afvis", blokeres alle ikke-angivne forbindelsestyper som standard, medmindre det udtrykkeligt er tilladt. Denne indstilling fungerer som en global reservepolitik og er afgørende for at gennemtvinge en sikker standardstilling i miljøer, hvor kun kendte og pålidelige forbindelser skal være tilladt.
rules	OutboundConnectionRule[]	En liste over regler, der definerer funktionsmåden for udgående adgang for bestemte typer cloudforbindelser. Hver regel kan indeholde begrænsninger baseret på slutpunkter eller arbejdsområder, afhængigt af understøttede forbindelsestyper.

Del via

Workspaces - Get Outbound Cloud Connection Rules

Tilladelser

Påkrævede delegerede områder

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Svar

Eksempler

Get workspace outbound access protection cloud connection rule for example

Eksempelanmodning

Eksempelsvar

Definitioner

ConnectionAccessActionType

ConnectionRuleEndpointMetadata

ConnectionRuleWorkspaceMetadata

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OutboundConnectionRule

WorkspaceOutboundConnections