Udostępnij przez

Workspaces - Set Network Communication Policy

Usługa:
Core
Wersja interfejsu API:
v1

Ustawia zasady komunikacji sieciowej dla określonego obszaru roboczego. Ten interfejs API używa metody PUT i zastąpi wszystkie ustawienia. Pozostałe zasady zostaną ustawione na wartość domyślną, jeśli w treści żądania zostaną podane tylko częściowe zasady. Najpierw uruchom polecenie Pobierz zasady komunikacji sieciowej i podaj pełne zasady w treści żądania. 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.

Permissions

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

Wymagane zakresy delegowane

Workspace.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość Support
User Tak
Jednostka usługi i tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

Wartość elementu ETag. Element ETag musi być określony w cudzysłowie. Jeśli zostanie podana wartość , wywołanie powiedzie się tylko wtedy, gdy element ETag zasobu jest zgodny z podanym elementem ETag.

Treść żądania

Nazwa Typ Opis
inbound

InboundRules

Właściwości komunikacji sieciowej dla ruchu przychodzącego dla obszaru roboczego.
outbound

OutboundRules

Właściwości komunikacji sieciowej ruchu wychodzącego dla obszaru roboczego.

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 networking communication policy example

Przykładowe żądanie

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

{
  "inbound": {
    "publicAccessRules": {
      "defaultAction": "Allow"
    }
  },
  "outbound": {
    "publicAccessRules": {
      "defaultAction": "Deny"
    }
  }
}

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

Zasady dotyczące całej komunikacji przychodzącej do obszaru roboczego.
NetworkAccessRule

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych.
NetworkRules

Zasady definiujące dostęp do/z obszaru roboczego do/z sieci publicznych.
OutboundRules

Zasady dotyczące całej komunikacji wychodzącej z obszaru roboczego.
WorkspaceNetworkingCommunicationPolicy

Zasady komunikacji sieciowej dla obszaru roboczego.

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.

InboundRules

Objekt

Zasady dotyczące całej komunikacji przychodzącej do obszaru roboczego.

Nazwa Typ Opis
publicAccessRules

NetworkRules

Zasady dotyczące komunikacji przychodzącej do obszaru roboczego z sieci publicznych.

NetworkAccessRule

Wyliczanie

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych.

Wartość Opis
Allow

Zezwalaj na wszystkie połączenia.
Deny

Odmów wszystkich połączeń.

NetworkRules

Objekt

Zasady definiujące dostęp do/z obszaru roboczego do/z sieci publicznych.

Nazwa Typ Opis
defaultAction

NetworkAccessRule

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych.

OutboundRules

Objekt

Zasady dotyczące całej komunikacji wychodzącej z obszaru roboczego.

Nazwa Typ Opis
publicAccessRules

NetworkRules

Zasady dotyczące komunikacji wychodzącej z sieci publicznych z obszaru roboczego.

WorkspaceNetworkingCommunicationPolicy

Objekt

Zasady komunikacji sieciowej dla obszaru roboczego.

Nazwa Typ Opis
inbound

InboundRules

Właściwości komunikacji sieciowej dla ruchu przychodzącego dla obszaru roboczego.
outbound

OutboundRules

Właściwości komunikacji sieciowej ruchu wychodzącego dla obszaru roboczego.