Workspaces - Get Outbound Gateway Rules

Служба:: Core

Версия API:: v1

Возвращает правила шлюза для рабочей области, включенной с помощью защиты от исходящего доступа (OAP).
Этот API помогает администраторам рабочей области просматривать действующие политики исходящего сетевого взаимодействия, применяемые для локальных и виртуальных сетевых шлюзов данных. Правила шлюза возвращаются и применяются только в том случае, если для политики outbound.publicAccessRules.defaultAction сетевой связи рабочей области задано значение Deny. Если OAP не включен для рабочей области, API завершается ошибкой, так как исходящие подключения не ограничены.

Permissions

Вызывающий объект должен иметь или более поздней роли рабочей области.

Обязательные делегированные области

Workspace.Read.All или Workspace.ReadWrite.All

поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Уникальный идентификатор рабочей области, в которой запрашиваются правила исходящего трафика.

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	WorkspaceOutboundGateways	Запрос успешно завершен. Заголовки ETag: string
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка.

WorkspaceOutboundGateways

Запрос успешно завершен.

Заголовки

ETag: string

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

UnknownError — произошла ошибка.

Примеры

Get workspace outbound access protection gateway rule for example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    }
  ]
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GatewayAccessActionType	Определяет поведение управления доступом для исходящих шлюзов. Эта перечисление используется для поля defaultAction, чтобы указать, следует ли разрешить исходящее взаимодействие или запретить по умолчанию. Этот тип обеспечивает как глобальный, так и определенный шлюз контроль над исходящим доступом, что помогает применять безопасные и прогнозируемые политики сетевого взаимодействия. С течением времени могут добавляться дополнительные типы действий доступа к шлюзу.
GatewayAccessRuleMetadata	Представляет шлюз, разрешенный для исходящего взаимодействия. Этот объект используется в разрешенныхGateways для явной авторизации исходящего доступа.
WorkspaceOutboundGateways	Представляет полный набор правил защиты исходящего доступа шлюза, настроенных для рабочей области в рамках политики сетевой связи. Этот объект определяет правила шлюза, которые управляют исходящим обменом данными

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable	boolean	Если задано значение true, запрос можно получить. `Retry-After` Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GatewayAccessActionType

Перечисление

Определяет поведение управления доступом для исходящих шлюзов. Эта перечисление используется для поля defaultAction, чтобы указать, следует ли разрешить исходящее взаимодействие или запретить по умолчанию. Этот тип обеспечивает как глобальный, так и определенный шлюз контроль над исходящим доступом, что помогает применять безопасные и прогнозируемые политики сетевого взаимодействия. С течением времени могут добавляться дополнительные типы действий доступа к шлюзу.

Значение	Описание
Allow	Разрешает исходящие шлюзы. При использовании в качестве действия по умолчанию разрешены все шлюзы.
Deny	Блокирует исходящие шлюзы. При использовании в качестве действия по умолчанию все шлюзы запрещены, если явно не разрешено.

GatewayAccessRuleMetadata

Объект

Представляет шлюз, разрешенный для исходящего взаимодействия. Этот объект используется в разрешенныхGateways для явной авторизации исходящего доступа.

Имя	Тип	Описание
id	string (uuid)	Допустимый идентификатор шлюза.

WorkspaceOutboundGateways

Объект

Представляет полный набор правил защиты исходящего доступа шлюза, настроенных для рабочей области в рамках политики сетевой связи. Этот объект определяет правила шлюза, которые управляют исходящим обменом данными

Имя	Тип	Описание
allowedGateways	GatewayAccessRuleMetadata[]	Список правил, определяющих поведение исходящего доступа для шлюзов.
defaultAction	GatewayAccessActionType	Определяет поведение по умолчанию для всех шлюзов, которые не указаны явным образом в массиве разрешенных списков. Если задано значение Allow, все неопределенные шлюзы разрешены по умолчанию. Если задано значение "Запретить", все неопределенные шлюзы блокируются. Если не указано в тексте запроса PUT, это поле по умолчанию `Allow`имеет значение , которое может непреднамеренно разрешать все исходящие подключения шлюза. Всегда явно укажите это поле в каждом тексте запроса PUT.