Workspaces - Get Firewall Rules

บริการ:: Core

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

แสดงกฎไฟร์วอลล์ IP สําหรับพื้นที่ทํางาน API นี้ได้รับการออกแบบมาเพื่อช่วยให้ผู้ดูแลระบบพื้นที่ทํางานสามารถดูกฎไฟร์วอลล์ IP ที่มีประสิทธิภาพได้ ขณะนี้ คุณลักษณะนี้อยู่ในการการแสดงตัวอย่าง

Note

API นี้เป็นส่วนหนึ่งของการเผยแพร่ตัวอย่าง และมีไว้เพื่อวัตถุประสงค์ในการประเมินและการพัฒนาเท่านั้น ซึ่งอาจเปลี่ยนแปลงตามคําติชมและไม่แนะนําสําหรับการใช้งานด้านการผลิต

การอนุญาต

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

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

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

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

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

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

อิน เทอร์ เฟซ

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

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

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

การตอบสนอง

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

200 OK

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

InboundFirewallConfiguration

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

ส่วนหัว:

ETagstring - ETag ปัจจุบันของการกําหนดค่าไฟร์วอลล์ ใช้ค่านี้ในส่วนหัวของ If-Match การเรียก PUT ที่ตามมาเพื่อใช้ตัวควบคุมภาวะพร้อมกันในเชิงบวก

429 Too Many Requests

ErrorResponse

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

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

Example for getting workspace firewall rules

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

HTTP

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

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

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

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

{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
FirewallRule	กําหนดกฎของไฟร์วอลล์ที่ระบุโดยชื่อและประกอบด้วยที่อยู่ IP เดียวช่วงที่อยู่ IP หรือที่อยู่ IP CIDR เป็นค่า
InboundFirewallConfiguration	วัตถุนี้กําหนดชุดกฎไฟร์วอลล์ที่สมบูรณ์เพื่อจัดการการป้องกันการเข้าถึงขาเข้าโดยเป็นส่วนหนึ่งของนโยบายการสื่อสารเครือข่ายของพื้นที่ทํางาน ซึ่งทําให้แน่ใจว่าเฉพาะที่อยู่ IP ที่ได้รับอนุญาตอย่างชัดเจนเท่านั้นที่ได้รับอนุญาตสําหรับการสื่อสารขาเข้า เมื่อส่งผ่าน PUT API ออบเจ็กต์นี้จะสร้างหรือแทนที่การกําหนดค่าไฟร์วอลล์ IP ที่มีอยู่สําหรับพื้นที่ทํางานอย่างเต็มที่ กฎเหล่านี้จะถูกบังคับใช้เฉพาะเมื่อนโยบายการสื่อสารเครือข่ายของพื้นที่ทํางานมี inbound.publicAccessRules.defaultAction ที่ตั้งค่าเป็น Deny

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	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

FirewallRule

วัตถุ

กําหนดกฎของไฟร์วอลล์ที่ระบุโดยชื่อและประกอบด้วยที่อยู่ IP เดียวช่วงที่อยู่ IP หรือที่อยู่ IP CIDR เป็นค่า

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ระบุชื่อของกฎ ชื่อที่แสดงสามารถมีความยาวได้สูงสุด 128 อักขระ และจําเป็นต้องไม่ซ้ํากันต่อพื้นที่ทํางาน
value	string	ระบุค่าของกฎ ที่ระบุเป็นที่อยู่ IP เดียว ช่วงที่อยู่ IP หรือที่อยู่ IP CIDR

InboundFirewallConfiguration

วัตถุ

วัตถุนี้กําหนดชุดกฎไฟร์วอลล์ที่สมบูรณ์เพื่อจัดการการป้องกันการเข้าถึงขาเข้าโดยเป็นส่วนหนึ่งของนโยบายการสื่อสารเครือข่ายของพื้นที่ทํางาน ซึ่งทําให้แน่ใจว่าเฉพาะที่อยู่ IP ที่ได้รับอนุญาตอย่างชัดเจนเท่านั้นที่ได้รับอนุญาตสําหรับการสื่อสารขาเข้า เมื่อส่งผ่าน PUT API ออบเจ็กต์นี้จะสร้างหรือแทนที่การกําหนดค่าไฟร์วอลล์ IP ที่มีอยู่สําหรับพื้นที่ทํางานอย่างเต็มที่ กฎเหล่านี้จะถูกบังคับใช้เฉพาะเมื่อนโยบายการสื่อสารเครือข่ายของพื้นที่ทํางานมี inbound.publicAccessRules.defaultAction ที่ตั้งค่าเป็น Deny

ชื่อ	พิมพ์	คำอธิบาย
rules	FirewallRule[]	รายการของกฎที่กําหนดที่อยู่ IP ที่อนุญาตสําหรับการเข้าถึงขาเข้า กฎแต่ละกฎอาจรวมถึงชื่อและที่อยู่ IP เดียว ช่วงที่อยู่ IP หรือที่อยู่ IP CIDR สามารถระบุกฎได้สูงสุด 256 กฎต่อพื้นที่ทํางาน