Workspaces - Set Outbound Gateway Rules

服务:: Core

API 版本:: v1

为启用了出站访问保护（OAP）的工作区设置网关规则。此 API 使工作区管理员能够定义、替换或替代一组出站网络通信策略，以控制允许当前工作区允许哪些本地 /Vnet 数据网关。此功能目前处于预览状态。

注释

此 API 是预览版的一部分，仅用于评估和开发目的。它可能会根据反馈进行更改，不建议将其用于生产。

注释

仅当工作区的网络通信策略将 outbound.publicAccessRules.defaultAction 设置为 Deny 时，才会强制实施出站访问保护规则。如果未在工作区上启用 OAP，则 API 会失败，因为出站连接不受限制。

注释

此 API 使用 PUT 方法，并将覆盖工作区的所有出站访问网关。如果请求正文中提供了部分策略，则剩余策略将设置为默认值。始终先运行 Get，并在请求正文中提供完整策略。

Permissions

调用方必须具有 管理员 工作区角色。

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	Support
用户	是的
服务主体和托管标识	是的

接口

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	要更新的工作区的唯一标识符。

请求正文

名称	类型	说明
allowedGateways	GatewayAccessRuleMetadata[]	定义网关出站访问行为的规则列表。
defaultAction	GatewayAccessActionType	定义未在允许的列表数组中显式列出的所有网关的默认行为。如果设置为“允许”，则默认允许所有未指定的网关。如果设置为“拒绝”，则阻止所有未指定的网关。

响应

名称	类型	说明
200 OK		请求成功完成。标头 ETag: string
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误。

名称

类型

说明

200 OK

请求成功完成。

标头

ETag: string

Other Status Codes

ErrorResponse

常见错误代码：

UnknownError - 发生错误。

示例

Set workspace outbound access protection gateway rule for example

示例请求

HTTP

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"
    }
  ]
}

示例响应

状态代码:: 200

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

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GatewayAccessActionType	定义出站网关的访问控制行为。此枚举用于字段 defaultAction，以指定默认情况下是应允许还是拒绝出站通信。此类型支持全局和特定于网关的出站访问控制，帮助强制实施安全且可预测的网络通信策略。可能会随着时间的推移添加其他网关访问作类型。
GatewayAccessRuleMetadata	表示允许进行出站通信的网关。此对象在 allowedGateways 中用于显式授权出站访问。
WorkspaceOutboundGateways	表示为工作区配置的一组完整的网关出站访问保护规则，作为其网络通信策略的一部分。此对象定义用于控制出站通信的网关规则

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

GatewayAccessActionType

枚举

定义出站网关的访问控制行为。此枚举用于字段 defaultAction，以指定默认情况下是应允许还是拒绝出站通信。此类型支持全局和特定于网关的出站访问控制，帮助强制实施安全且可预测的网络通信策略。可能会随着时间的推移添加其他网关访问作类型。

值	说明
Allow	允许出站网关。用作默认作时，允许所有网关。
Deny	阻止出站网关。用作默认作时，除非显式允许，否则将拒绝所有网关。

GatewayAccessRuleMetadata

Object

表示允许进行出站通信的网关。此对象在 allowedGateways 中用于显式授权出站访问。

名称	类型	说明
id	string (uuid)	允许网关 ID。

WorkspaceOutboundGateways

Object

表示为工作区配置的一组完整的网关出站访问保护规则，作为其网络通信策略的一部分。此对象定义用于控制出站通信的网关规则

名称	类型	说明
allowedGateways	GatewayAccessRuleMetadata[]	定义网关出站访问行为的规则列表。
defaultAction	GatewayAccessActionType	定义未在允许的列表数组中显式列出的所有网关的默认行为。如果设置为“允许”，则默认允许所有未指定的网关。如果设置为“拒绝”，则阻止所有未指定的网关。

通过

Workspaces - Set Outbound Gateway Rules

Permissions

所需的委派范围

Microsoft Entra 支持的标识

接口

URI 参数

请求正文

响应

示例

Set workspace outbound access protection gateway rule for example

示例请求

示例响应

定义

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GatewayAccessActionType

GatewayAccessRuleMetadata

WorkspaceOutboundGateways