Workspaces - Set Git Outbound Policy

Usługa:
Core
Wersja interfejsu API:
v1

Ustawia zasady ruchu wychodzącego Usługi Git dla określonego obszaru roboczego, gdy zasady ruchu wychodzącego są ustawione na wartość "Odmów".
Ten interfejs API używa metody PUT i zastępuje wszystkie ustawienia. Gdy obszar roboczy ogranicza zasady ruchu wychodzącego, administrator obszaru roboczego musi zezwolić na korzystanie z integracji z usługą Git w określonym obszarze roboczym. Jeśli w obszarze roboczym nie ma żadnych ograniczeń dotyczących ruchu wychodzącego, zmiana tej właściwości zakończy się niepowodzeniem i nie wpłynie na ustawienie integracji usługi Git. Zawsze najpierw wywołaj operację Pobierz zasady ruchu wychodzącego usługi Git i podaj pełne zasady w treści żądania.

Note

Jeśli defaultAction treść żądania zostanie pominięta, wartość domyślna Allowto , co może przypadkowo zezwalać na integrację z usługą Git, gdy dostęp wychodzący powinien być ograniczony. 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

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/git

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Nagłówek żądania

Nazwisko Wymagane Typ Opis
If-Match

string

Wartość 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

Nazwisko Typ Opis
defaultAction

NetworkAccessRule

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allow, co może przypadkowo otworzyć dostęp sieciowy. 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 networking communication policy example

Przykładowe żądanie

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

{
  "defaultAction": "Allow"
}

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

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allow, co może przypadkowo otworzyć dostęp sieciowy. Zawsze jawnie określ to pole w każdej treści żądania PUT.
NetworkRules

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

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.

NetworkAccessRule

Wyliczenie

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allow, co może przypadkowo otworzyć dostęp sieciowy. Zawsze jawnie określ to pole w każdej treści żądania PUT.

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.

Nazwisko Typ Opis
defaultAction

NetworkAccessRule

Domyślne zasady dostępu do obszaru roboczego z sieci publicznych. Jeśli pominięto treść żądania PUT, to pole jest domyślnie ustawione na Allow, co może przypadkowo otworzyć dostęp sieciowy. Zawsze jawnie określ to pole w każdej treści żądania PUT.