Workspaces - Set Firewall Rules

Usługa:: Core

Wersja interfejsu API:: v1

Ustawia reguły zapory adresów IP dla obszaru roboczego. Ten interfejs API umożliwia administratorom obszarów roboczych ustawianie reguł zapory adresów IP, które kontrolują, które adresy IP mają być dozwolone do łączenia się z obszarem roboczym. Ta funkcja jest obecnie w wersji zapoznawczej.

Note

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.

Note

Reguły zapory są wymuszane tylko wtedy, gdy zasady komunikacji sieciowej obszaru roboczego mają wartość inbound.publicAccessRules.defaultAction ustawioną na odmów. Jeśli dostęp publiczny nie jest blokowany w obszarze roboczym, wywołania interfejsu API do tego obszaru roboczego nie będą ograniczone.

Note

Ten interfejs API używa metody PUT i zastąpi wszystkie reguły zapory IP dla obszaru roboczego. Zawsze uruchamiaj polecenie Pobierz najpierw i podaj wszystkie reguły zapory ip 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.

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

Interface

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Unikatowy identyfikator obszaru roboczego do zaktualizowania.

Treść żądania

Nazwisko	Typ	Opis
rules	FirewallRule[]	Lista reguł, które definiują adresy IP dozwolone dla dostępu przychodzącego. Każda reguła może zawierać nazwę i pojedynczy adres IP, zakres adresów IP lub adres IP CIDR. Na obszar roboczy można określić maksymalnie 256 reguł.

Odpowiedzi

Nazwisko Typ Opis

200 OK

Nazwisko	Typ	Opis
200 OK		Żądanie zostało ukończone pomyślnie i nie ma zawartości w treści odpowiedzi. Nagłówki: Etag`string` — nowy element ETag konfiguracji zapory po aktualizacji. Użyj tej wartości w nagłówku `If-Match` kolejnego wywołania PUT, aby zastosować optymistyczną kontrolę współbieżności.
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.

Żądanie zostało ukończone pomyślnie i nie ma zawartości w treści odpowiedzi.

Nagłówki:

Etagstring — nowy element ETag konfiguracji zapory po aktualizacji. Użyj tej wartości w nagłówku If-Match kolejnego wywołania PUT, aby zastosować optymistyczną kontrolę współbieżności.

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

Example for setting workspace firewall rules

Przykładowe żądanie

HTTP

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

{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:: 204

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ółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
FirewallRule	Definiuje regułę zapory, zidentyfikowaną przez jej nazwę i zawierającą jeden adres IP, zakres adresów IP lub adres IP CIDR jako jego wartość.
InboundFirewallConfiguration	Ten obiekt definiuje pełny zestaw reguł zapory do zarządzania ochroną dostępu przychodzącego w ramach zasad komunikacji sieciowej obszaru roboczego. Gwarantuje to, że tylko jawnie autoryzowane adresy IP są dozwolone dla komunikacji przychodzącej. Po przesłaniu za pośrednictwem interfejsu API PUT ten obiekt tworzy lub w pełni zastępuje istniejącą konfigurację zapory IP dla obszaru roboczego. Te reguły są wymuszane tylko wtedy, gdy zasady komunikacji sieciowej obszaru roboczego mają wartość inbound.publicAccessRules.defaultAction ustawioną na odmów.

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ółowych informacji o zasobie związanym z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

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.

FirewallRule

Objekt

Definiuje regułę zapory, zidentyfikowaną przez jej nazwę i zawierającą jeden adres IP, zakres adresów IP lub adres IP CIDR jako jego wartość.

Nazwisko	Typ	Opis
displayName	string	Określa nazwę reguły. Nazwy wyświetlane mogą zawierać maksymalnie 128 znaków i muszą być unikatowe dla każdego obszaru roboczego.
value	string	Określa wartość reguły, określonej jako pojedynczy adres IP, zakres adresów IP lub adres IP CIDR.

InboundFirewallConfiguration

Objekt

Ten obiekt definiuje pełny zestaw reguł zapory do zarządzania ochroną dostępu przychodzącego w ramach zasad komunikacji sieciowej obszaru roboczego. Gwarantuje to, że tylko jawnie autoryzowane adresy IP są dozwolone dla komunikacji przychodzącej. Po przesłaniu za pośrednictwem interfejsu API PUT ten obiekt tworzy lub w pełni zastępuje istniejącą konfigurację zapory IP dla obszaru roboczego. Te reguły są wymuszane tylko wtedy, gdy zasady komunikacji sieciowej obszaru roboczego mają wartość inbound.publicAccessRules.defaultAction ustawioną na odmów.

Nazwisko	Typ	Opis
rules	FirewallRule[]	Lista reguł, które definiują adresy IP dozwolone dla dostępu przychodzącego. Każda reguła może zawierać nazwę i pojedynczy adres IP, zakres adresów IP lub adres IP CIDR. Na obszar roboczy można określić maksymalnie 256 reguł.