通过

Workspaces - Set Network Communication Policy

服务:
Core
API 版本:
v1

设置指定工作区的网络通信策略。 此 API 使用 PUT 方法，并将覆盖所有设置。 仅当请求正文中仅提供部分策略时，剩余策略将设置为默认值。 始终先运行“获取网络通信策略”，并在请求正文中提供完整策略。 此功能目前以预览版提供。

注释

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

Permissions

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

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string (uuid)

工作区 ID。

请求头

名称 必需 类型 说明
If-Match

string

ETag 值。 必须在引号中指定 ETag。 如果提供，则仅当资源的 ETag 与提供的 ETag 匹配时，调用才会成功。

请求正文

名称 类型 说明
inbound

InboundRules

工作区的入站网络通信属性。
outbound

OutboundRules

工作区的出站网络通信属性。

响应

名称 类型 说明
200 OK

请求成功完成。

标头

ETag: string
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Set workspace networking communication policy example

示例请求

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

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

示例响应

状态代码:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

定义

名称 说明
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
InboundRules

所有入站通信到工作区的策略。
NetworkAccessRule

从公用网络访问工作区的默认策略。
NetworkRules

定义访问/从工作区访问/从公用网络访问的策略。
OutboundRules

来自工作区的所有出站通信的策略。
WorkspaceNetworkingCommunicationPolicy

工作区的网络通信策略。

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

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

InboundRules

Object

所有入站通信到工作区的策略。

名称 类型 说明
publicAccessRules

NetworkRules

从公用网络到工作区的入站通信的策略。

NetworkAccessRule

枚举

从公用网络访问工作区的默认策略。

值 说明
Allow

允许所有连接。
Deny

拒绝所有连接。

NetworkRules

Object

定义访问/从工作区访问/从公用网络访问的策略。

名称 类型 说明
defaultAction

NetworkAccessRule

从公用网络访问工作区的默认策略。

OutboundRules

Object

来自工作区的所有出站通信的策略。

名称 类型 说明
publicAccessRules

NetworkRules

从工作区到公用网络出站通信的策略。

WorkspaceNetworkingCommunicationPolicy

Object

工作区的网络通信策略。

名称 类型 说明
inbound

InboundRules

工作区的入站网络通信属性。
outbound

OutboundRules

工作区的出站网络通信属性。