Udostępnij przez

Workspaces - Set Outbound Gateway Rules

Usługa:
Core
Wersja interfejsu API:
v1

Ustawia reguły bramy dla obszaru roboczego włączonego za pomocą ochrony dostępu wychodzącego (OAP). Ten interfejs API umożliwia administratorom obszarów roboczych definiowanie, zastępowanie lub zastępowanie zestawu wychodzących zasad komunikacji sieciowej, które kontrolują, które bramy danych sieci lokalnej /Vnet mają być dozwolone z bieżącego obszaru roboczego. Ta funkcja jest obecnie dostępna w wersji zapoznawczej.

Uwaga / Notatka

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Uwaga / Notatka

Reguły ochrony dostępu wychodzącego są wymuszane tylko wtedy, gdy zasady komunikacji sieciowej obszaru roboczego mają wartość outbound.publicAccessRules.defaultAction ustawioną na Odmów. Jeśli protokół OAP nie jest włączony w obszarze roboczym, interfejs API kończy się niepowodzeniem, ponieważ połączenia wychodzące nie są ograniczone.

Uwaga / Notatka

Ten interfejs API używa metody PUT i zastąpi wszystkie bramy dostępu wychodzącego dla obszaru roboczego. Pozostałe zasady zostaną ustawione na wartość domyślną, jeśli zasady częściowe zostaną podane w treści żądania. Zawsze uruchamiaj polecenie Pobierz najpierw i podaj pełne zasady w treści żądania.

Permissions

Obiekt wywołujący musi mieć rolę administratora obszaru roboczego.

Wymagane zakresy delegowane

Przestrzeń robocza.OdczytZapis.Wszystko

Tożsamości obsługiwane przez Microsoft Entra

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

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Unikatowy identyfikator obszaru roboczego do zaktualizowania.

Treść żądania

Nazwa Typ Opis
allowedGateways

GatewayAccessRuleMetadata[]

Lista reguł definiujących zachowanie dostępu wychodzącego dla bram.
defaultAction

GatewayAccessActionType

Definiuje domyślne zachowanie wszystkich bram, które nie są jawnie wymienione w tablicy dozwolonych list. W przypadku ustawienia opcji "Zezwalaj" wszystkie nieokreślone bramy są domyślnie dozwolone. Jeśli ustawiono wartość "Odmów", wszystkie nieokreślone bramy zostaną zablokowane.

Odpowiedzi

Nazwa Typ Opis
200 OK

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

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Typowe kody błędów:

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

Przykłady

Set workspace outbound access protection gateway rule for example

Przykładowe żądanie

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

{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    },
    {
      "id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
    }
  ]
}

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

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

Definiuje zachowanie kontroli dostępu dla bram 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 bramy kontrolę dostępu wychodzącego, ułatwiając wymuszanie bezpiecznych i przewidywalnych zasad komunikacji sieciowej. Dodatkowe typy akcji dostępu do bramy mogą być dodawane w czasie.
GatewayAccessRuleMetadata

Reprezentuje bramę dozwoloną dla komunikacji wychodzącej. Ten obiekt jest używany w dozwolonych Bramach do jawnego autoryzowania dostępu wychodzącego.
WorkspaceOutboundGateways

Reprezentuje kompletny zestaw reguł ochrony dostępu wychodzącego bramy skonfigurowanych dla obszaru roboczego w ramach zasad komunikacji sieciowej. Ten obiekt definiuje reguły bramy, które zarządzają komunikacją wychodzącą

ErrorRelatedResource

Objekt

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

Nazwa 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.

Nazwa 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.
moreDetails

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa 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.
relatedResource

ErrorRelatedResource

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

GatewayAccessActionType

Wyliczanie

Definiuje zachowanie kontroli dostępu dla bram 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 bramy kontrolę dostępu wychodzącego, ułatwiając wymuszanie bezpiecznych i przewidywalnych zasad komunikacji sieciowej. Dodatkowe typy akcji dostępu do bramy mogą być dodawane w czasie.

Wartość Opis
Allow

Zezwala na bramy wychodzące. W przypadku użycia jako akcji domyślnej wszystkie bramy są dozwolone.
Deny

Blokuje bramy wychodzące. W przypadku użycia jako akcji domyślnej wszystkie bramy są odrzucane, chyba że jawnie dozwolone.

GatewayAccessRuleMetadata

Objekt

Reprezentuje bramę dozwoloną dla komunikacji wychodzącej. Ten obiekt jest używany w dozwolonych Bramach do jawnego autoryzowania dostępu wychodzącego.

Nazwa Typ Opis
id

string (uuid)

Identyfikator bramy może być dozwolony.

WorkspaceOutboundGateways

Objekt

Reprezentuje kompletny zestaw reguł ochrony dostępu wychodzącego bramy skonfigurowanych dla obszaru roboczego w ramach zasad komunikacji sieciowej. Ten obiekt definiuje reguły bramy, które zarządzają komunikacją wychodzącą

Nazwa Typ Opis
allowedGateways

GatewayAccessRuleMetadata[]

Lista reguł definiujących zachowanie dostępu wychodzącego dla bram.
defaultAction

GatewayAccessActionType

Definiuje domyślne zachowanie wszystkich bram, które nie są jawnie wymienione w tablicy dozwolonych list. W przypadku ustawienia opcji "Zezwalaj" wszystkie nieokreślone bramy są domyślnie dozwolone. Jeśli ustawiono wartość "Odmów", wszystkie nieokreślone bramy zostaną zablokowane.