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.

Uwaga / Notatka

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

Uwaga / Notatka

Ten interfejs API używa metody PUT i zastępuje wszystkie bramy dostępu wychodzącego dla obszaru roboczego. Zawsze najpierw wywołaj operację Pobierz reguły bramy i podaj pełne zasady w treści żądania.

Uwaga / Notatka

Jeśli defaultAction treść żądania zostanie pominięta, wartość domyślna to , co może przypadkowo zezwalać Allowna wszystkie połączenia bramy wychodzącej. Zawsze jawnie określaj defaultAction w każdej treści żądania PUT.

Permissions

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

Wymagane zakresy delegowane

Przestrzeń robocza.OdczytZapis.Wszystko

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

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Unikatowy identyfikator obszaru roboczego do zaktualizowania.

Treść żądania

Nazwisko 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. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allowwartość , co może przypadkowo zezwalać na wszystkie połączenia bramy wychodzącej. Zawsze jawnie określ to pole w każdej treści żądania PUT.

Odpowiedzi

Nazwisko Typ Opis
200 OK

Żą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

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

Nazwisko Opis
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.
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ą

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.

GatewayAccessActionType

Wyliczenie

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.

Nazwisko 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ą

Nazwisko 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. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allowwartość , co może przypadkowo zezwalać na wszystkie połączenia bramy wychodzącej. Zawsze jawnie określ to pole w każdej treści żądania PUT.