Connections - Update Connection Role Assignment

บริการ:: Admin

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

อัปเดตการกําหนดบทบาทหลักสําหรับการเชื่อมต่อ

Note

Fabric การจัดการการเชื่อมต่อผู้ดูแลผู้เช่าอยู่ในการแสดงตัวอย่าง (เรียนรู้เพิ่มเติม)

Permissions

ผู้เรียกต้องเป็นผู้ดูแลระบบ Fabric หรือรับรองความถูกต้องโดยใช้โครงร่างสําคัญของบริการ

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

Tenant.ReadWrite.All

Limitations

ไม่มีข้อจํากัดเพิ่มเติม

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

API นี้สนับสนุน Microsoft identitiesที่ระบุในส่วนนี้

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

Interface

PATCH https://api.fabric.microsoft.com/v1/admin/connections/{connectionId}/roleAssignments/{connectionRoleAssignmentId}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
connectionId	path	True	string (uuid)	ID การเชื่อมต่อ
connectionRoleAssignmentId	path	True	string (uuid)	รหัสของการกําหนดบทบาทการเชื่อมต่อ

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

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
role	True	AssignableAdminConnectionRole	บทบาทการเชื่อมต่อของโครงร่างสําคัญ

การตอบสนอง

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

200 OK

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

ConnectionRoleAssignment

ตกลง, ได้ การดําเนินการสําเร็จ

429 Too Many Requests

ErrorResponse

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

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

Update connection role assignment as admin example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/admin/connections/fe8e181d-dbb8-471a-99f0-fdbf0a2ad4fd/roleAssignments/43970761-afc9-4428-ae6e-3b08bef098ff

{
  "role": "Owner"
}

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

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

{
  "id": "43970761-afc9-4428-ae6e-3b08bef098ff",
  "principal": {
    "id": "43970761-afc9-4428-ae6e-3b08bef098ff",
    "type": "User"
  },
  "role": "Owner"
}

คำจำกัดความ

ชื่อ	คำอธิบาย
AssignableAdminConnectionRole	บทบาทการเชื่อมต่อ บทบาทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
ConnectionRole	บทบาทการเชื่อมต่อ บทบาทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
ConnectionRoleAssignment	การกําหนดบทบาทการเชื่อมต่อสําหรับรายการหลัก
EntireTenantPrincipal	แสดงองค์ประกอบหลักของผู้เช่า
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
GroupDetails	รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก `Group`
GroupPrincipal	แสดงกลุ่มความปลอดภัย
GroupType	ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป
PrincipalType	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
ServicePrincipalDetails	รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก `ServicePrincipal`
ServicePrincipalPrincipal	แสดง Microsoft Entra บริการหลัก
ServicePrincipalProfileDetails	รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก `ServicePrincipalProfile`
ServicePrincipalProfilePrincipal	แสดงโปรไฟล์บริการหลัก
UpdateAdminConnectionRoleAssignmentRequest	อัปเดตคําขอกําหนดบทบาทการเชื่อมต่อของส่วนข้อมูล
UserDetails	รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก `User`
UserPrincipal	แสดง Microsoft Entra หลักของผู้ใช้

AssignableAdminConnectionRole

การแจงนับ

บทบาทการเชื่อมต่อ บทบาทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Owner	ช่วยให้เงินต้นเพื่อรับความเป็นเจ้าของการเชื่อมต่อ หลักจะได้รับมอบหมายบทบาท 'PendingOwner' ในขั้นต้น และเพื่อเสร็จสิ้นการเปลี่ยนเป็น 'เจ้าของ' หลักต้องอัปเดตข้อมูลประจําตัวการเชื่อมต่อโดยใช้ อัปเดตการเชื่อมต่อ API

ค่า

คำอธิบาย

Owner

ช่วยให้เงินต้นเพื่อรับความเป็นเจ้าของการเชื่อมต่อ หลักจะได้รับมอบหมายบทบาท 'PendingOwner' ในขั้นต้น และเพื่อเสร็จสิ้นการเปลี่ยนเป็น 'เจ้าของ' หลักต้องอัปเดตข้อมูลประจําตัวการเชื่อมต่อโดยใช้ อัปเดตการเชื่อมต่อ API

ConnectionRole

การแจงนับ

บทบาทการเชื่อมต่อ บทบาทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
User	เปิดใช้งานการเข้าถึงของผู้ใช้สําหรับการเชื่อมต่อ
UserWithReshare	ช่วยให้ผู้ใช้สามารถแชร์การเข้าถึงอีกครั้งสําหรับการเชื่อมต่อได้
Owner	เปิดใช้งานการเข้าถึงความเป็นเจ้าของสําหรับการเชื่อมต่อ
PendingOwner	ความเป็นเจ้าของการเชื่อมต่อยังไม่มีผล หลักต้องอัปเดตข้อมูลประจําตัวการเชื่อมต่อ (โดยใช้ API อัปเดตการเชื่อมต่อ) เพื่อทําให้มีประสิทธิภาพ

ConnectionRoleAssignment

วัตถุ

การกําหนดบทบาทการเชื่อมต่อสําหรับรายการหลัก

ชื่อ	พิมพ์	คำอธิบาย
id	string (uuid)	ID ออปเจ็กต์ของการกําหนดบทบาทการเชื่อมต่อ
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	ครูใหญ่
role	ConnectionRole	บทบาทการเชื่อมต่อของโครงร่างสําคัญ

EntireTenantPrincipal

วัตถุ

แสดงองค์ประกอบหลักของผู้เช่า

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงขององค์ประกอบหลัก
id	string (uuid)	ID ของโครงร่างสําคัญ
type	string: EntireTenant	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

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

GroupDetails

วัตถุ

รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group

ชื่อ	พิมพ์	คำอธิบาย
groupType	GroupType	ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป

GroupPrincipal

วัตถุ

แสดงกลุ่มความปลอดภัย

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงขององค์ประกอบหลัก
groupDetails	GroupDetails	รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก `Group`
id	string (uuid)	ID ของโครงร่างสําคัญ
type	string: Group	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

GroupType

การแจงนับ

ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Unknown	ไม่รู้จักชนิดกลุ่มหลัก
SecurityGroup	หลักคือกลุ่มความปลอดภัย
DistributionList	หลักคือรายการการแจกจ่าย

PrincipalType

การแจงนับ

ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
User	หลักเป็น Microsoft Entra หลักของผู้ใช้
ServicePrincipal	หลักเป็น Microsoft Entra บริการหลัก
Group	หลักคือกลุ่มความปลอดภัย
ServicePrincipalProfile	หลักคือ โปรไฟล์โครงร่างสําคัญของบริการ
EntireTenant	หลักแสดงผู้ใช้ที่เป็นผู้เช่าทั้งหมด

ServicePrincipalDetails

วัตถุ

รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal

ชื่อ	พิมพ์	คำอธิบาย
aadAppId	string (uuid)	AppId Microsoft Entra ของโครงร่างสําคัญของบริการ

ServicePrincipalPrincipal

วัตถุ

แสดง Microsoft Entra บริการหลัก

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงขององค์ประกอบหลัก
id	string (uuid)	ID ของโครงร่างสําคัญ
servicePrincipalDetails	ServicePrincipalDetails	รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก `ServicePrincipal`
type	string: ServicePrincipal	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

ServicePrincipalProfileDetails

วัตถุ

รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile

ชื่อ	พิมพ์	คำอธิบาย
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	โครงร่างสําคัญของโปรไฟล์บริการหลัก

ServicePrincipalProfilePrincipal

วัตถุ

แสดงโปรไฟล์บริการหลัก

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงขององค์ประกอบหลัก
id	string (uuid)	ID ของโครงร่างสําคัญ
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก `ServicePrincipalProfile`
type	string: ServicePrincipalProfile	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

UpdateAdminConnectionRoleAssignmentRequest

วัตถุ

อัปเดตคําขอกําหนดบทบาทการเชื่อมต่อของส่วนข้อมูล

ชื่อ	พิมพ์	คำอธิบาย
role	AssignableAdminConnectionRole	บทบาทการเชื่อมต่อของโครงร่างสําคัญ

UserDetails

วัตถุ

รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก User

ชื่อ	พิมพ์	คำอธิบาย
userPrincipalName	string	ชื่อหลักของผู้ใช้

UserPrincipal

วัตถุ

แสดง Microsoft Entra หลักของผู้ใช้

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงขององค์ประกอบหลัก
id	string (uuid)	ID ของโครงร่างสําคัญ
type	string: User	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
userDetails	UserDetails	รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก `User`