Workspaces - Get Outbound Cloud Connection Rules

บริการ:: Core

เวอร์ชัน API:: v1

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

สิทธิ์

ผู้เรียกต้องมีบทบาท ของผู้ชม หรือสูงกว่าพื้นที่ทํางาน

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

Workspace.Read.All หรือ Workspace.ReadWrite.All

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

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

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

อิน เทอร์ เฟซ

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

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ตัวระบุที่ไม่ซ้ําของพื้นที่ทํางานที่มีกฎขาออกกําลังถูกคิวรี

การตอบสนอง

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

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	WorkspaceOutboundConnections	คําขอเสร็จสมบูรณ์ ส่วนหัว ETag: string
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: UnknownError - เกิดข้อผิดพลาด

WorkspaceOutboundConnections

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

ส่วนหัว

ETag: string

429 Too Many Requests

ErrorResponse

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

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

Get workspace outbound access protection cloud connection rule for example

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

HTTP

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

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

รหัสสถานะ:: 200

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

{
  "defaultAction": "Deny",
  "rules": [
    {
      "connectionType": "SQL",
      "defaultAction": "Deny",
      "allowedEndpoints": [
        {
          "hostnamePattern": "*.microsoft.com"
        }
      ]
    },
    {
      "connectionType": "LakeHouse",
      "defaultAction": "Deny",
      "allowedWorkspaces": [
        {
          "workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
        }
      ]
    },
    {
      "connectionType": "Web",
      "defaultAction": "Allow"
    }
  ]
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ConnectionAccessActionType	กําหนดลักษณะการทํางานของการควบคุมการเข้าถึงสําหรับการเชื่อมต่อขาออก Enum นี้ใช้สําหรับฟิลด์ defaultAction เพื่อระบุว่าควรอนุญาตหรือปฏิเสธการสื่อสารขาออกตามค่าเริ่มต้น ประเภทนี้เปิดใช้งานทั้งส่วนกลางและการควบคุมเฉพาะการเชื่อมต่อผ่านการเข้าถึงขาออกช่วยในการบังคับใช้นโยบายการสื่อสารเครือข่ายที่ปลอดภัยและคาดการณ์ได้ ประเภทการดําเนินการเข้าถึงการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
ConnectionRuleEndpointMetadata	แสดงกฎข้อยกเว้นระดับปลายทางเดียวที่อนุญาตให้สื่อสารขาออกไปยังโดเมนหรือโฮสต์ภายนอกที่เฉพาะเจาะจง วัตถุนี้ถูกใช้ภายในอาร์เรย์ AllowedEndpoints ของกฎการเชื่อมต่อเพื่ออนุญาตการเข้าถึงปลายทางขาออกที่เชื่อถือได้สําหรับ connectionType ที่กําหนดอย่างชัดเจน ซึ่งสามารถใช้ได้เฉพาะกับชนิดการเชื่อมต่อที่สนับสนุนการกรองตามจุดสิ้นสุดเท่านั้น (เช่น SQL, MySQL, เว็บ และอื่น ๆ)
ConnectionRuleWorkspaceMetadata	แสดงกฎข้อยกเว้นระดับพื้นที่ทํางานที่อนุญาตให้สื่อสารขาออกไปยังพื้นที่ทํางานเฉพาะสําหรับ connectionType ที่กําหนด วัตถุนี้ถูกใช้ภายในอาร์เรย์ AllowedWorkspaces ของกฎการเชื่อมต่อเพื่อให้อนุญาตการเข้าถึงข้ามพื้นที่ทํางานอย่างชัดเจน สามารถใช้ได้เฉพาะกับชนิดการเชื่อมต่อที่สนับสนุนการกรองตามพื้นที่ทํางาน เช่น Lakehouse, Warehouse, FabricSql และ PowerPlatformDataflows เท่านั้น
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
OutboundConnectionRule	กําหนดกฎการเข้าถึงขาออกสําหรับการเชื่อมต่อระบบคลาวด์เฉพาะ
WorkspaceOutboundConnections	แสดงชุดของกฎการเชื่อมต่อระบบคลาวด์ของการป้องกันการเข้าถึงขาออกที่กําหนดค่าสําหรับพื้นที่ทํางานเป็นส่วนหนึ่งของนโยบายการสื่อสารเครือข่าย ออบเจ็กต์นี้จะกําหนดกฎการเชื่อมต่อที่ควบคุมว่าปลายทางและพื้นที่ทํางานภายนอกใดที่ได้รับอนุญาตหรือปฏิเสธสําหรับการสื่อสารขาออก

ConnectionAccessActionType

การแจงนับ

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

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

ConnectionRuleEndpointMetadata

วัตถุ

แสดงกฎข้อยกเว้นระดับปลายทางเดียวที่อนุญาตให้สื่อสารขาออกไปยังโดเมนหรือโฮสต์ภายนอกที่เฉพาะเจาะจง วัตถุนี้ถูกใช้ภายในอาร์เรย์ AllowedEndpoints ของกฎการเชื่อมต่อเพื่ออนุญาตการเข้าถึงปลายทางขาออกที่เชื่อถือได้สําหรับ connectionType ที่กําหนดอย่างชัดเจน ซึ่งสามารถใช้ได้เฉพาะกับชนิดการเชื่อมต่อที่สนับสนุนการกรองตามจุดสิ้นสุดเท่านั้น (เช่น SQL, MySQL, เว็บ และอื่น ๆ)

ชื่อ	พิมพ์	คำอธิบาย
hostnamePattern	string	รูปแบบที่รองรับสัญลักษณ์ตัวแทนที่กําหนดจุดสิ้นสุดภายนอกที่ได้รับอนุญาต ตัวอย่างเช่น *.microsoft.com, api.contoso.com หรือ data.partner.org

ConnectionRuleWorkspaceMetadata

วัตถุ

แสดงกฎข้อยกเว้นระดับพื้นที่ทํางานที่อนุญาตให้สื่อสารขาออกไปยังพื้นที่ทํางานเฉพาะสําหรับ connectionType ที่กําหนด วัตถุนี้ถูกใช้ภายในอาร์เรย์ AllowedWorkspaces ของกฎการเชื่อมต่อเพื่อให้อนุญาตการเข้าถึงข้ามพื้นที่ทํางานอย่างชัดเจน สามารถใช้ได้เฉพาะกับชนิดการเชื่อมต่อที่สนับสนุนการกรองตามพื้นที่ทํางาน เช่น Lakehouse, Warehouse, FabricSql และ PowerPlatformDataflows เท่านั้น

ชื่อ	พิมพ์	คำอธิบาย
workspaceId	string (uuid)	ตัวระบุที่ไม่ซ้ํากัน (GUID) ของพื้นที่ทํางานเป้าหมายที่ได้รับอนุญาตให้เชื่อมต่อจากพื้นที่ทํางานปัจจุบัน

ErrorRelatedResource

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

OutboundConnectionRule

วัตถุ

กําหนดกฎการเข้าถึงขาออกสําหรับการเชื่อมต่อระบบคลาวด์เฉพาะ

ชื่อ	พิมพ์	คำอธิบาย
allowedEndpoints	ConnectionRuleEndpointMetadata[]	กําหนดรายการของจุดสิ้นสุดภายนอกที่อนุญาตอย่างชัดเจนสําหรับ connectionType รายการแต่ละรายการในอาร์เรย์ แสดงถึงรูปแบบชื่อโฮสต์ที่ได้รับอนุญาตสําหรับการสื่อสารขาออกจากพื้นที่ทํางาน ฟิลด์นี้จะใช้ได้เฉพาะกับชนิดการเชื่อมต่อที่สนับสนุนการกรองตามปลายทาง (เช่น SQL, MySQL, เว็บ และอื่น ๆ) เท่านั้น ถ้ามีการตั้งค่า defaultAction เป็น "ปฏิเสธ" สําหรับชนิดการเชื่อมต่อ เฉพาะจุดสิ้นสุดที่แสดงไว้ที่นี่เท่านั้นที่ได้รับอนุญาต รายการอื่นๆ ทั้งหมดจะถูกบล็อก
allowedWorkspaces	ConnectionRuleWorkspaceMetadata[]	ระบุรายการของรหัสพื้นที่ทํางานที่ได้รับอนุญาตอย่างชัดเจนสําหรับการสื่อสารขาออกสําหรับชนิดการเชื่อมต่อผ้าที่ระบุ เขตข้อมูลนี้สามารถใช้ได้เฉพาะกับชนิดการเชื่อมต่อผ้าที่สนับสนุนการกรองตามพื้นที่ทํางาน จํากัดอยู่ที่ Lakehouse, Warehouse, FabricSql และ PowerPlatformDataflows เมื่อ defaultAction ถูกตั้งค่าเป็น "ปฏิเสธ" สําหรับชนิดการเชื่อมต่อ เฉพาะพื้นที่ทํางานที่แสดงใน allowedWorkspaces เท่านั้นที่จะได้รับอนุญาตให้เข้าถึงขาออกได้ รายการอื่นๆ ทั้งหมดจะถูกบล็อก
connectionType	string	ระบุชนิดการเชื่อมต่อคลาวด์ที่ใช้กฎ ลักษณะการทํางานและการใช้งานของคุณสมบัติกฎอื่น ๆ (เช่น allowedEndpoints หรือ allowedWorkspaces) อาจแตกต่างกันขึ้นอยู่กับความสามารถของชนิดการเชื่อมต่อ
defaultAction	ConnectionAccessActionType	กําหนดลักษณะการทํางานการเข้าถึงขาออกเริ่มต้นสําหรับ connectionType ฟิลด์นี้กําหนดว่าการเชื่อมต่อของชนิดนี้ได้รับอนุญาตหรือบล็อกตามค่าเริ่มต้น เว้นแต่ว่ามีการปรับแต่งเพิ่มเติมโดย AllowedEndpoints หรือ AllowedWorkspaces ถ้าตั้งค่าเป็น "อนุญาต": การเชื่อมต่อทั้งหมดของชนิดนี้จะได้รับอนุญาตให้ดําเนินการเว้นแต่จะถูกปฏิเสธอย่างชัดเจนโดยกฎที่เฉพาะเจาะจงมากขึ้น เขตข้อมูลนี้มีตัวควบคุมแบบละเอียดเหนือชนิดการเชื่อมต่อแต่ละชนิด และเสริมลักษณะการทํางานที่ใช้แสดงแทนส่วนกลางที่กําหนดโดย defaultAction

WorkspaceOutboundConnections

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
defaultAction	ConnectionAccessActionType	กําหนดลักษณะการทํางานเริ่มต้นสําหรับชนิดการเชื่อมต่อระบบคลาวด์ทั้งหมดที่ไม่ได้ระบุไว้อย่างชัดเจนในอาร์เรย์ของกฎ ถ้าตั้งค่าเป็น "อนุญาต" ชนิดการเชื่อมต่อที่ไม่ได้ระบุทั้งหมดจะได้รับอนุญาตให้ตามค่าเริ่มต้น ถ้าตั้งค่าเป็น "Deny" ชนิดการเชื่อมต่อที่ไม่ได้ระบุทั้งหมดจะถูกบล็อกตามค่าเริ่มต้น เว้นแต่ว่าได้รับอนุญาตอย่างชัดเจน การตั้งค่านี้ทําหน้าที่เป็นนโยบายที่ใช้แสดงแทนสากล และมีความสําคัญสําหรับการบังคับใช้ท่าทางเริ่มต้นที่ปลอดภัยในสภาพแวดล้อมที่ควรอนุญาตเฉพาะการเชื่อมต่อที่รู้จักและเชื่อถือได้เท่านั้น ถ้าเว้นไว้จากเนื้อความของคําขอ PUT เขตข้อมูลนี้จะเป็นค่าเริ่มต้น `Allow`ซึ่งอาจอนุญาตให้มีการเชื่อมต่อขาออกทั้งหมดโดยไม่ได้ตั้งใจ ระบุเขตข้อมูลนี้อย่างชัดเจนทุกครั้งในทุกเนื้อความของคําขอ PUT
rules	OutboundConnectionRule[]	รายการของกฎที่กําหนดลักษณะการทํางานการเข้าถึงขาออกสําหรับชนิดการเชื่อมต่อระบบคลาวด์ที่เฉพาะเจาะจง กฎแต่ละกฎอาจมีข้อจํากัดตามตําแหน่งข้อมูลหรือตามพื้นที่ทํางาน ทั้งนี้ขึ้นอยู่กับชนิดการเชื่อมต่อที่ได้รับการสนับสนุน