Managed Private Endpoints - Create Workspace Managed Private Endpoint
สร้างจุดปลายทางส่วนตัวที่มีการจัดการในพื้นที่ทํางานที่ระบุ
Note
API นี้เป็นส่วนหนึ่งของการเผยแพร่ตัวอย่าง และมีไว้เพื่อวัตถุประสงค์ในการประเมินและการพัฒนาเท่านั้น ซึ่งอาจเปลี่ยนแปลงตามคําติชมและไม่แนะนําสําหรับการใช้งานด้านการผลิต
Permissions
ผู้เรียกต้องมีบทบาทพื้นที่ทํางาน ของผู้ดูแลระบบ
จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์
Workspace.ReadWrite.All.
Limitations
- เมื่อต้องสร้างจุดสิ้นสุดส่วนตัวที่มีการจัดการ พื้นที่ทํางานต้องอยู่บนความจุ Fabric ที่ได้รับการสนับสนุน สําหรับข้อมูลเพิ่มเติม ดูที่: สิทธิ์การใช้งาน Microsoft Fabric
ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra
API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้
| Identity | Support |
|---|---|
| User | Yes |
| บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ | Yes |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints
พารามิเตอร์ URI
| ชื่อ | ใน | จำเป็น | พิมพ์ | คำอธิบาย |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
ID พื้นที่ทํางาน |
เนื้อความของคำขอ
| ชื่อ | จำเป็น | พิมพ์ | คำอธิบาย |
|---|---|---|---|
| name | True |
string |
ชื่อจุดปลายทางส่วนตัว ไม่ควรมีอักขระมากกว่า 64 ตัว |
| targetPrivateLinkResourceId | True |
string |
รหัสทรัพยากรของแหล่งข้อมูลที่จุดสิ้นสุดส่วนตัวจําเป็นต้องถูกสร้างขึ้น |
| requestMessage |
string |
ข้อความที่จะอนุมัติคําขอปลายทางส่วนตัว ไม่ควรมีอักขระมากกว่า 140 ตัว |
|
| targetFQDNs |
string[] |
ชื่อโดเมนที่มีคุณสมบัติครบถ้วน (FQDNs) ที่จะเชื่อมโยงกับจุดสิ้นสุดส่วนตัว ไม่ควรมากกว่า 20 FQDNs |
|
| targetSubresourceType |
string |
ทรัพยากรย่อยชี้ไปยังที่เก็บลิงก์ส่วนตัว |
การตอบสนอง
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| 201 Created |
คําขอเสร็จสมบูรณ์ ส่วนหัว Location: string |
|
| Other Status Codes |
รหัสข้อผิดพลาดทั่วไป:
|
ตัวอย่าง
Create a managed private endpoint example
คำขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints
{
"name": "testprivatendpoint1",
"targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsql1",
"targetSubresourceType": "sqlServer",
"requestMessage": "Request message to approve private endpoint"
}
คำตอบตัวอย่าง
Location: https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints/59a92b06-6e5a-468c-b748-e28c8ff28da3
{
"id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
"name": "SqlPE",
"targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
"provisioningState": "Provisioning",
"targetSubresourceType": "sqlServer"
}
คำจำกัดความ
| ชื่อ | คำอธิบาย |
|---|---|
|
Connection |
สถานะการเชื่อมต่อปลายทางส่วนตัว สถานะการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป |
|
Create |
สร้างส่วนข้อมูลคําขอปลายทางส่วนตัวที่มีการจัดการ |
|
Error |
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
Error |
การตอบสนองข้อผิดพลาด |
|
Error |
รายละเอียดการตอบสนองข้อผิดพลาด |
|
Managed |
จุดปลายทางส่วนตัวที่มีการจัดการ |
|
Private |
สถานะการเชื่อมต่อปลายทางส่วนตัว |
|
Private |
สถานะการเตรียมใช้งานของปลายทาง |
ConnectionStatus
สถานะการเชื่อมต่อปลายทางส่วนตัว สถานะการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| Pending |
ค้างอยู่รอการอนุมัติ |
| Approved |
อนุมัติปลายทางแล้ว |
| Rejected |
จุดสิ้นสุดที่ถูกปฏิเสธ |
| Disconnected |
จุดสิ้นสุดถูกยกเลิกการเชื่อมต่อ |
CreateManagedPrivateEndpointRequest
สร้างส่วนข้อมูลคําขอปลายทางส่วนตัวที่มีการจัดการ
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| name |
string |
ชื่อจุดปลายทางส่วนตัว ไม่ควรมีอักขระมากกว่า 64 ตัว |
| requestMessage |
string |
ข้อความที่จะอนุมัติคําขอปลายทางส่วนตัว ไม่ควรมีอักขระมากกว่า 140 ตัว |
| targetFQDNs |
string[] |
ชื่อโดเมนที่มีคุณสมบัติครบถ้วน (FQDNs) ที่จะเชื่อมโยงกับจุดสิ้นสุดส่วนตัว ไม่ควรมากกว่า 20 FQDNs |
| targetPrivateLinkResourceId |
string |
รหัสทรัพยากรของแหล่งข้อมูลที่จุดสิ้นสุดส่วนตัวจําเป็นต้องถูกสร้างขึ้น |
| targetSubresourceType |
string |
ทรัพยากรย่อยชี้ไปยังที่เก็บลิงก์ส่วนตัว |
ErrorRelatedResource
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| resourceId |
string |
ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
| resourceType |
string |
ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponse
การตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| moreDetails |
รายการรายละเอียดข้อผิดพลาดเพิ่มเติม |
|
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
| requestId |
string |
รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponseDetails
รายละเอียดการตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ManagedPrivateEndpoint
จุดปลายทางส่วนตัวที่มีการจัดการ
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| connectionState |
สถานะการเชื่อมต่อปลายทางของจุดสิ้นสุดที่เตรียมใช้งาน |
|
| id |
string (uuid) |
จัดการรหัสจุดปลายทางส่วนตัวแล้ว |
| name |
string |
ชื่อจุดปลายทางส่วนตัว |
| provisioningState |
สถานะการเตรียมใช้งานของปลายทาง |
|
| targetPrivateLinkResourceId |
string |
รหัสทรัพยากรของแหล่งข้อมูลที่สร้างจุดปลายทางส่วนตัวขึ้น |
| targetSubresourceType |
string |
ทรัพยากรย่อยชี้ไปยังที่เก็บลิงก์ส่วนตัว |
PrivateEndpointConnectionState
สถานะการเชื่อมต่อปลายทางส่วนตัว
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| actionsRequired |
string |
การดําเนินการที่จําเป็นเพื่อสร้างการเชื่อมต่อ |
| description |
string |
ข้อความคําอธิบาย (ถ้ามี) ที่มีให้ในการอนุมัติหรือปฏิเสธจุดสิ้นสุด |
| status |
สถานะการเชื่อมต่อ |
PrivateEndpointProvisioningState
สถานะการเตรียมใช้งานของปลายทาง
| ค่า | คำอธิบาย |
|---|---|
| Provisioning |
จุดสิ้นสุดส่วนตัวในการเตรียมใช้งานอยู่ในระหว่างดําเนินการ |
| Succeeded |
การเตรียมใช้งานจุดสิ้นสุดส่วนตัวสําเร็จ |
| Updating |
การอัปเดตจุดสิ้นสุดส่วนตัว |
| Deleting |
การลบปลายทางส่วนตัว |
| Failed |
การเตรียมใช้งานจุดสิ้นสุดส่วนตัวล้มเหลว |