Workspaces - Set Firewall Rules

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

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

Note

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

Note

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

Note

API นี้ใช้วิธีการ PUT และจะเขียนทับกฎไฟร์วอลล์ IP ทั้งหมดสําหรับพื้นที่ทํางาน เรียกใช้รับก่อนและให้กฎไฟร์วอลล์ทั้งหมดภายในเนื้อความของคําขอเสมอ

การอนุญาต

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

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

Workspace.ReadWrite.All

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

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

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

อิน เทอร์ เฟซ

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

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

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

string (uuid)

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

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

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

FirewallRule[]

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

การตอบสนอง

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

การร้องขอเสร็จสมบูรณ์ และไม่มีเนื้อหาในเนื้อหาคําตอบ

ส่วนหัว:

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

ErrorResponse

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

ส่วนหัว

Retry-After: integer
Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

Example for setting workspace firewall rules

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

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

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

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

รหัสสถานะ:
204 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

คำจำกัดความ

ชื่อ คำอธิบาย
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 กฎต่อพื้นที่ทํางาน