Workspaces - Get Outbound Cloud Connection Rules

Usługa:
Core
Wersja interfejsu API:
v1

Zwraca reguły połączeń w chmurze dla obszaru roboczego włączonego z ochroną dostępu wychodzącego (OAP).
Ten interfejs API pomaga administratorom obszarów roboczych wyświetlać obowiązujące zasady komunikacji sieciowej ruchu wychodzącego wymuszane dla połączeń w chmurze. Reguły połączeń w chmurze są zwracane i stosowane tylko wtedy, gdy zasady komunikacji sieciowej obszaru roboczego mają outbound.publicAccessRules.defaultAction wartość Deny. Jeśli protokół OAP nie jest włączony dla obszaru roboczego, interfejs API zakończy się niepowodzeniem, ponieważ połączenia wychodzące nie są ograniczone.

Permissions

Obiekt wywołujący musi mieć lub większą rolę obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Microsoft Entra obsługiwane tożsamości

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Support
User Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Unikatowy identyfikator obszaru roboczego, do którego są wykonywane zapytania dotyczące reguł ruchu wychodzącego.

Odpowiedzi

Nazwisko Typ Opis
200 OK

WorkspaceOutboundConnections

Żądanie zostało ukończone pomyślnie.

Nagłówki

ETag: string
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • UnknownError — wystąpił błąd.

Przykłady

Get workspace outbound access protection cloud connection rule for example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
    }
  ]
}

Definicje

Nazwisko Opis
ConnectionAccessActionType

Definiuje zachowanie kontroli dostępu dla połączeń wychodzących. To wyliczenie jest używane dla pola defaultAction, aby określić, czy komunikacja wychodząca powinna być domyślnie dozwolona, czy blokowana. Ten typ umożliwia zarówno globalną, jak i specyficzną dla połączenia kontrolę dostępu wychodzącego, pomagając wymuszać bezpieczne i przewidywalne zasady komunikacji sieciowej. Dodatkowe typy akcji dostępu do połączeń mogą być dodawane w czasie.
ConnectionRuleEndpointMetadata

Reprezentuje regułę wyjątku na poziomie pojedynczego punktu końcowego, która zezwala na komunikację wychodzącą z określoną domeną zewnętrzną lub hostem. Ten obiekt jest używany w tablicy allowedEndpoints reguły połączenia, aby jawnie autoryzować dostęp wychodzący do zaufanych punktów końcowych dla danego parametru connectionType. Dotyczy to tylko typów połączeń, które obsługują filtrowanie oparte na punkcie końcowym (np. SQL, MySQL, Web itp.).
ConnectionRuleWorkspaceMetadata

Reprezentuje regułę wyjątku na poziomie obszaru roboczego, która umożliwia komunikację wychodzącą z określonym obszarem roboczym dla danego parametru connectionType. Ten obiekt jest używany w tablicy allowedWorkspaces reguły połączenia, aby jawnie autoryzować dostęp między obszarami roboczymi. Dotyczy to tylko typów połączeń, które obsługują filtrowanie oparte na obszarze roboczym, takie jak Lakehouse, Warehouse, FabricSql i PowerPlatformDataflows.
ErrorParameter

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
OutboundConnectionRule

Definiuje regułę dostępu wychodzącego dla określonego połączenia w chmurze.
WorkspaceOutboundConnections

Reprezentuje kompletny zestaw reguł połączeń z chmurą ochrony dostępu wychodzącego skonfigurowanych dla obszaru roboczego w ramach zasad komunikacji sieciowej. Ten obiekt definiuje reguły połączeń, które określają, które zewnętrzne punkty końcowe i obszary robocze są dozwolone lub blokowane dla komunikacji wychodzącej

ConnectionAccessActionType

Wyliczenie

Definiuje zachowanie kontroli dostępu dla połączeń wychodzących. To wyliczenie jest używane dla pola defaultAction, aby określić, czy komunikacja wychodząca powinna być domyślnie dozwolona, czy blokowana. Ten typ umożliwia zarówno globalną, jak i specyficzną dla połączenia kontrolę dostępu wychodzącego, pomagając wymuszać bezpieczne i przewidywalne zasady komunikacji sieciowej. Dodatkowe typy akcji dostępu do połączeń mogą być dodawane w czasie.

Wartość Opis
Allow

Zezwala na połączenia wychodzące. W przypadku użycia jako akcji domyślnej wszystkie połączenia w chmurze są dozwolone.
Deny

Blokuje połączenia wychodzące. W przypadku użycia jako akcji domyślnej wszystkie połączenia w chmurze są odrzucane, chyba że jawnie dozwolone.

ConnectionRuleEndpointMetadata

Objekt

Reprezentuje regułę wyjątku na poziomie pojedynczego punktu końcowego, która zezwala na komunikację wychodzącą z określoną domeną zewnętrzną lub hostem. Ten obiekt jest używany w tablicy allowedEndpoints reguły połączenia, aby jawnie autoryzować dostęp wychodzący do zaufanych punktów końcowych dla danego parametru connectionType. Dotyczy to tylko typów połączeń, które obsługują filtrowanie oparte na punkcie końcowym (np. SQL, MySQL, Web itp.).

Nazwisko Typ Opis
hostnamePattern

string

Wzorzec obsługiwany przez symbol wieloznaczny, który definiuje dozwolony zewnętrzny punkt końcowy. Przykłady obejmują *.microsoft.com, api.contoso.com lub data.partner.org.

ConnectionRuleWorkspaceMetadata

Objekt

Reprezentuje regułę wyjątku na poziomie obszaru roboczego, która umożliwia komunikację wychodzącą z określonym obszarem roboczym dla danego parametru connectionType. Ten obiekt jest używany w tablicy allowedWorkspaces reguły połączenia, aby jawnie autoryzować dostęp między obszarami roboczymi. Dotyczy to tylko typów połączeń, które obsługują filtrowanie oparte na obszarze roboczym, takie jak Lakehouse, Warehouse, FabricSql i PowerPlatformDataflows.

Nazwisko Typ Opis
workspaceId

string (uuid)

Unikatowy identyfikator (GUID) docelowego obszaru roboczego, który może być połączony z bieżącym obszarem roboczym.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko Typ Opis
message

string

Czytelny dla człowieka opis znaczenia parametru.
name

string

Identyfikator parametru.
value

string

Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

OutboundConnectionRule

Objekt

Definiuje regułę dostępu wychodzącego dla określonego połączenia w chmurze.

Nazwisko Typ Opis
allowedEndpoints

ConnectionRuleEndpointMetadata[]

Definiuje listę jawnie dozwolonych zewnętrznych punktów końcowych dla parametru connectionType. Każdy wpis w tablicy reprezentuje wzorzec nazwy hosta dozwolony dla komunikacji wychodzącej z obszaru roboczego. To pole ma zastosowanie tylko do typów połączeń, które obsługują filtrowanie oparte na punkcie końcowym (np. SQL, MySQL, Web itp.). Jeśli ustawienie defaultAction ma wartość "Odmów" dla typu połączenia, dozwolone będą tylko punkty końcowe wymienione tutaj; wszystkie inne zostaną zablokowane.
allowedWorkspaces

ConnectionRuleWorkspaceMetadata[]

Określa listę identyfikatorów obszarów roboczych, które są jawnie dozwolone dla komunikacji wychodzącej dla danego parametru connectionType sieci szkieletowej. To pole ma zastosowanie tylko do typów połączeń sieci szkieletowych, które obsługują filtrowanie oparte na obszarze roboczym, ograniczone do usługi Lakehouse, Warehouse, FabricSql i PowerPlatformDataflows. Jeśli ustawienie defaultAction ma wartość "Odmów" dla typu połączenia, tylko obszary robocze wymienione w obszarze allowedWorkspaces będą dozwolone dla dostępu wychodzącego; wszystkie inne zostaną zablokowane.
connectionType

string

Określa typ połączenia w chmurze, do którego ma zastosowanie reguła. Zachowanie i zastosowanie innych właściwości reguły (takich jak allowedEndpoints lub allowedWorkspaces) może się różnić w zależności od możliwości typu połączenia.
defaultAction

ConnectionAccessActionType

Definiuje domyślne zachowanie dostępu wychodzącego dla parametru connectionType. To pole określa, czy połączenia tego typu są domyślnie dozwolone lub blokowane, chyba że bardziej uściślić dozwolone Punkty końcowe lub dozwoloneWorkspaces. Jeśli ustawiono wartość "Zezwalaj": wszystkie połączenia tego typu są dozwolone, chyba że jawnie odmówiono przez bardziej szczegółową regułę. To pole zapewnia szczegółową kontrolę nad każdym typem połączenia i uzupełnia globalne zachowanie rezerwowe zdefiniowane domyślnie.

WorkspaceOutboundConnections

Objekt

Reprezentuje kompletny zestaw reguł połączeń z chmurą ochrony dostępu wychodzącego skonfigurowanych dla obszaru roboczego w ramach zasad komunikacji sieciowej. Ten obiekt definiuje reguły połączeń, które określają, które zewnętrzne punkty końcowe i obszary robocze są dozwolone lub blokowane dla komunikacji wychodzącej

Nazwisko Typ Opis
defaultAction

ConnectionAccessActionType

Definiuje domyślne zachowanie dla wszystkich typów połączeń w chmurze, które nie są jawnie wymienione w tablicy reguł. W przypadku ustawienia opcji "Zezwalaj" wszystkie nieokreślone typy połączeń są domyślnie dozwolone. W przypadku ustawienia opcji "Odmów" wszystkie nieokreślone typy połączeń są domyślnie blokowane, chyba że jawnie dozwolone. To ustawienie działa jako globalne zasady rezerwowe i ma kluczowe znaczenie dla wymuszania bezpiecznego stanu domyślnego w środowiskach, w których powinny być dozwolone tylko znane i zaufane połączenia. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allowwartość , co może przypadkowo zezwalać na wszystkie połączenia wychodzące. Zawsze jawnie określ to pole w każdej treści żądania PUT.
rules

OutboundConnectionRule[]

Lista reguł definiujących zachowanie dostępu wychodzącego dla określonych typów połączeń w chmurze. Każda reguła może obejmować ograniczenia oparte na punkcie końcowym lub obszarze roboczym w zależności od obsługiwanych typów połączeń.