Workspaces - Set Outbound Gateway Rules

บริการ:
Core
เวอร์ชัน API:
v1

ตั้งค่ากฎเกตเวย์สําหรับพื้นที่ทํางานที่เปิดใช้งานด้วย การป้องกันการเข้าถึงขาออก (OAP)
API นี้ช่วยให้ผู้ดูแลระบบพื้นที่ทํางานสามารถกําหนด แทนที่ หรือแทนที่ชุดของนโยบายการสื่อสารเครือข่ายขาออกที่ควบคุมว่าจะอนุญาตเกตเวย์ข้อมูลภายในองค์กร /Vnet ใดจากพื้นที่ทํางานปัจจุบัน

Note

จะมีการบังคับใช้กฎการป้องกันการเข้าถึงขาออกเฉพาะเมื่อนโยบายการสื่อสารเครือข่ายของพื้นที่ทํางานมีoutbound.publicAccessRules.defaultActionการตั้งค่าเป็นDeny ถ้าไม่ได้เปิดใช้งาน OAP บนพื้นที่ทํางาน API ล้มเหลวเนื่องจากการเชื่อมต่อขาออกไม่ถูกจํากัด

Note

API นี้ใช้วิธีการ PUT และเขียนทับเกตเวย์การเข้าถึงขาออกทั้งหมดสําหรับพื้นที่ทํางาน เรียกใช้การดําเนินการ รับกฎเกตเวย์ ทุกครั้งและให้นโยบายเต็มรูปแบบในเนื้อความของคําขอ

Note

ถ้า defaultAction ถูกเว้นไว้จากเนื้อความของคําขอ จะใช้ค่าเริ่มต้นเป็น Allowซึ่งอาจอนุญาตให้มีการเชื่อมต่อเกตเวย์ขาออกทั้งหมดโดยไม่ได้ตั้งใจ ระบุ defaultAction อย่างชัดเจนทุกครั้งในทุกเนื้อความของคําขอ PUT

สิทธิ์

ผู้เรียกต้องมีบทบาทพื้นที่ทํางาน ของผู้ดูแลระบบ

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Workspace.ReadWrite.All

Microsoft Entra ข้อมูลประจําตัวที่ได้รับการสนับสนุน

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

Identity สนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ใช่

อิน เทอร์ เฟซ

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

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
workspaceId
 path True

string (uuid)

รหัสเฉพาะของพื้นที่ทํางานที่จะอัปเดต

เนื้อความของคำขอ

ชื่อ พิมพ์ คำอธิบาย
allowedGateways

GatewayAccessRuleMetadata[]

รายการของกฎที่กําหนดลักษณะการทํางานการเข้าถึงขาออกสําหรับเกตเวย์
defaultAction

GatewayAccessActionType

กําหนดลักษณะการทํางานเริ่มต้นสําหรับเกตเวย์ทั้งหมดที่ไม่ได้ระบุไว้อย่างชัดเจนในอาร์เรย์รายการที่อนุญาต ถ้าตั้งค่าเป็น "อนุญาต" เกตเวย์ที่ไม่ได้ระบุทั้งหมดจะได้รับอนุญาตให้ตามค่าเริ่มต้น ถ้าตั้งค่าเป็น "Deny" เกตเวย์ที่ไม่ได้ระบุทั้งหมดจะถูกบล็อก ถ้าเว้นไว้จากเนื้อความของคําขอ PUT เขตข้อมูลนี้จะเป็นค่าเริ่มต้น Allowซึ่งอาจอนุญาตให้มีการเชื่อมต่อเกตเวย์ขาออกทั้งหมดโดยไม่ได้ตั้งใจ ระบุเขตข้อมูลนี้อย่างชัดเจนทุกครั้งในทุกเนื้อความของคําขอ PUT

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

คําขอเสร็จสมบูรณ์

ส่วนหัว

ETag: string
429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer
Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • UnknownError - เกิดข้อผิดพลาด

ตัวอย่าง

Set workspace outbound access protection gateway rule for example

คำขอตัวอย่าง

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

คำจำกัดความ

ชื่อ คำอธิบาย
ErrorParameter

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
GatewayAccessActionType

กําหนดลักษณะการทํางานของการควบคุมการเข้าถึงสําหรับเกตเวย์ขาออก Enum นี้ใช้สําหรับฟิลด์ defaultAction เพื่อระบุว่าควรอนุญาตหรือปฏิเสธการสื่อสารขาออกตามค่าเริ่มต้น ประเภทนี้เปิดใช้งานทั้งส่วนกลางและการควบคุมเฉพาะเกตเวย์ผ่านการเข้าถึงขาออกช่วยในการบังคับใช้นโยบายการสื่อสารเครือข่ายที่ปลอดภัยและคาดการณ์ได้ ประเภทการดําเนินการเข้าถึงเกตเวย์เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
GatewayAccessRuleMetadata

แสดงเกตเวย์ที่ได้รับอนุญาตสําหรับการสื่อสารขาออก วัตถุนี้ถูกใช้ภายใน allowedGateways เพื่ออนุญาตการเข้าถึงขาออกอย่างชัดเจน
WorkspaceOutboundGateways

แสดงชุดของกฎการป้องกันการเข้าถึงขาออกของเกตเวย์ที่กําหนดค่าสําหรับพื้นที่ทํางานเป็นส่วนหนึ่งของนโยบายการสื่อสารเครือข่าย วัตถุนี้กําหนดกฎเกตเวย์ที่ควบคุมการสื่อสารขาออก

ErrorParameter

วัตถุ

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
message

string

คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์
name

string

ตัวระบุพารามิเตอร์
value

string

ค่าพารามิเตอร์

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable

boolean

เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง Retry-After เพื่อกําหนดความล่าช้า ถ้ามี
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
parameters

ErrorParameter[]

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string (uuid)

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
parameters

ErrorParameter[]

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

GatewayAccessActionType

การแจงนับ

กําหนดลักษณะการทํางานของการควบคุมการเข้าถึงสําหรับเกตเวย์ขาออก Enum นี้ใช้สําหรับฟิลด์ defaultAction เพื่อระบุว่าควรอนุญาตหรือปฏิเสธการสื่อสารขาออกตามค่าเริ่มต้น ประเภทนี้เปิดใช้งานทั้งส่วนกลางและการควบคุมเฉพาะเกตเวย์ผ่านการเข้าถึงขาออกช่วยในการบังคับใช้นโยบายการสื่อสารเครือข่ายที่ปลอดภัยและคาดการณ์ได้ ประเภทการดําเนินการเข้าถึงเกตเวย์เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Allow

อนุญาตเกตเวย์ขาออก เมื่อใช้เป็นการดําเนินการเริ่มต้น เกตเวย์ทั้งหมดจะได้รับอนุญาตให้ใช้งานได้
Deny

บล็อกเกตเวย์ขาออก เมื่อใช้เป็นการดําเนินการเริ่มต้น เกตเวย์ทั้งหมดจะถูกปฏิเสธเว้นแต่ได้รับอนุญาตอย่างชัดเจน

GatewayAccessRuleMetadata

วัตถุ

แสดงเกตเวย์ที่ได้รับอนุญาตสําหรับการสื่อสารขาออก วัตถุนี้ถูกใช้ภายใน allowedGateways เพื่ออนุญาตการเข้าถึงขาออกอย่างชัดเจน

ชื่อ พิมพ์ คำอธิบาย
id

string (uuid)

Id เกตเวย์ที่ได้รับอนุญาต

WorkspaceOutboundGateways

วัตถุ

แสดงชุดของกฎการป้องกันการเข้าถึงขาออกของเกตเวย์ที่กําหนดค่าสําหรับพื้นที่ทํางานเป็นส่วนหนึ่งของนโยบายการสื่อสารเครือข่าย วัตถุนี้กําหนดกฎเกตเวย์ที่ควบคุมการสื่อสารขาออก

ชื่อ พิมพ์ คำอธิบาย
allowedGateways

GatewayAccessRuleMetadata[]

รายการของกฎที่กําหนดลักษณะการทํางานการเข้าถึงขาออกสําหรับเกตเวย์
defaultAction

GatewayAccessActionType

กําหนดลักษณะการทํางานเริ่มต้นสําหรับเกตเวย์ทั้งหมดที่ไม่ได้ระบุไว้อย่างชัดเจนในอาร์เรย์รายการที่อนุญาต ถ้าตั้งค่าเป็น "อนุญาต" เกตเวย์ที่ไม่ได้ระบุทั้งหมดจะได้รับอนุญาตให้ตามค่าเริ่มต้น ถ้าตั้งค่าเป็น "Deny" เกตเวย์ที่ไม่ได้ระบุทั้งหมดจะถูกบล็อก ถ้าเว้นไว้จากเนื้อความของคําขอ PUT เขตข้อมูลนี้จะเป็นค่าเริ่มต้น Allowซึ่งอาจอนุญาตให้มีการเชื่อมต่อเกตเวย์ขาออกทั้งหมดโดยไม่ได้ตั้งใจ ระบุเขตข้อมูลนี้อย่างชัดเจนทุกครั้งในทุกเนื้อความของคําขอ PUT