Connections - List Connections

บริการ:: Core

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

แสดงรายการของการเชื่อมต่อภายในองค์กร เครือข่ายเสมือน และระบบคลาวด์ที่ผู้ใช้มีสิทธิ์

Permissions

ผู้เรียกต้องมีสิทธิ์สําหรับการเชื่อมต่อ

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

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

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

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

Identity	Support
User	Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	Yes

Interface

GET https://api.fabric.microsoft.com/v1/connections

ด้วยพารามิเตอร์ที่เลือกได้:

GET https://api.fabric.microsoft.com/v1/connections?continuationToken={continuationToken}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
continuationToken	query		string	โทเค็นสําหรับการเรียกใช้หน้าถัดไปของผลลัพธ์

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	ListConnectionsResponse	OK. การดําเนินการสําเร็จ
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: UnknownError - เกิดข้อผิดพลาด

ชื่อ

พิมพ์

คำอธิบาย

200 OK

ListConnectionsResponse

OK. การดําเนินการสําเร็จ

Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

Example

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

HTTP

GET https://api.fabric.microsoft.com/v1/connections

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

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

{
  "value": [
    {
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "displayName": "ContosoConnection1",
      "connectivityType": "ShareableCloud",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      },
      "privacyLevel": "Public",
      "credentialDetails": {
        "credentialType": "Anonymous",
        "singleSignOnType": "None",
        "connectionEncryption": "NotEncrypted",
        "skipTestConnection": false
      }
    },
    {
      "id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
      "displayName": "ContosoConnection2",
      "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
      "connectivityType": "OnPremisesGateway",
      "connectionDetails": {
        "type": "SQL",
        "path": "contoso.database.windows.net;sales"
      },
      "privacyLevel": "Organizational",
      "credentialDetails": {
        "credentialType": "Basic",
        "singleSignOnType": "None",
        "connectionEncryption": "Any",
        "skipTestConnection": false
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/connections?continuationToken=LDEsMTAwMDAwLDA%3D"
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ConnectionEncryption	ชนิดการเข้ารหัสลับการเชื่อมต่อของการเชื่อมต่อ อาจมีการเพิ่มค่าการเข้ารหัสลับการเชื่อมต่อเพิ่มเติมเมื่อเวลาผ่านไป
ConnectivityType	ชนิดการเชื่อมต่อของการเชื่อมต่อ ประเภทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
CredentialType	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ อาจมีการเพิ่มชนิดข้อมูลประจําตัวเพิ่มเติมเมื่อเวลาผ่านไป
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
ListConnectionDetails	รายละเอียดการเชื่อมต่อผลลัพธ์สําหรับการดําเนินการรายการ
ListConnectionsResponse
ListCredentialDetails	รายละเอียดข้อมูลประจําตัวส่งกลับเมื่อดึงข้อมูลการเชื่อมต่อ
OnPremisesGatewayConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กร
OnPremisesGatewayPersonalConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กรส่วนบุคคล
PersonalCloudConnection	การเชื่อมต่อที่เชื่อมต่อผ่านระบบคลาวด์และไม่สามารถแชร์ได้
PrivacyLevel	การตั้งค่าระดับความเป็นส่วนตัวของการเชื่อมต่อ อาจมีการเพิ่มระดับความเป็นส่วนตัวเพิ่มเติมเมื่อเวลาผ่านไป
ShareableCloudConnection	การเชื่อมต่อที่เชื่อมต่อผ่านระบบคลาวด์
SingleSignOnType	ชนิดการลงชื่อเข้าระบบครั้งเดียวของการเชื่อมต่อ อาจมีการเพิ่มการลงชื่อเข้าระบบครั้งเดียวเพิ่มเติมเมื่อเวลาผ่านไป
VirtualNetworkGatewayConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือน

ConnectionEncryption

การแจงนับ

ชนิดการเข้ารหัสลับการเชื่อมต่อของการเชื่อมต่อ อาจมีการเพิ่มค่าการเข้ารหัสลับการเชื่อมต่อเพิ่มเติมเมื่อเวลาผ่านไป

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

ConnectivityType

การแจงนับ

ชนิดการเชื่อมต่อของการเชื่อมต่อ ประเภทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
ShareableCloud	การเชื่อมต่อเชื่อมต่อผ่านระบบคลาวด์และสามารถแชร์กับผู้อื่นได้
PersonalCloud	การเชื่อมต่อเชื่อมต่อผ่านระบบคลาวด์และไม่สามารถแชร์กับผู้อื่นได้
OnPremisesGateway	การเชื่อมต่อจะเชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กร
OnPremisesGatewayPersonal	การเชื่อมต่อจะเชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กรส่วนบุคคล
VirtualNetworkGateway	การเชื่อมต่อจะเชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือน
Automatic	การเชื่อมต่อเชื่อมต่อผ่านระบบคลาวด์โดยใช้การเชื่อมต่อข้อมูลโดยนัย ตัวเลือกนี้พร้อมใช้งานสําหรับสถานการณ์เฉพาะเช่น แบบจําลองความหมายที่ใช้ Sign-On เดี่ยว (SSO)"
None	การเชื่อมต่อไม่ถูกผูกไว้

CredentialType

การแจงนับ

ชนิดข้อมูลประจําตัวของการเชื่อมต่อ อาจมีการเพิ่มชนิดข้อมูลประจําตัวเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Windows	การเชื่อมต่อใช้การรับรองความถูกต้องของ Windows เพื่อเชื่อมต่อ สนับสนุนเฉพาะเกตเวย์ภายในองค์กรเท่านั้น
Anonymous	การเชื่อมต่อใช้การรับรองความถูกต้องแบบไม่ระบุชื่อเพื่อเชื่อมต่อ
Basic	การเชื่อมต่อใช้การรับรองความถูกต้องพื้นฐานเพื่อเชื่อมต่อ
Key	การเชื่อมต่อใช้การรับรองความถูกต้องคีย์เพื่อเชื่อมต่อ
OAuth2	การเชื่อมต่อใช้การรับรองความถูกต้อง OAuth 2.0 เพื่อเชื่อมต่อ
WindowsWithoutImpersonation	การเชื่อมต่อใช้ Windows (โดยไม่มีตัวเลือกสําหรับการรับรองความถูกต้องเลียนแบบ) เพื่อเชื่อมต่อ สนับสนุนเฉพาะเกตเวย์ภายในองค์กร (โหมดส่วนบุคคล)
SharedAccessSignature	การเชื่อมต่อใช้การรับรองความถูกต้องลายเซ็นการเข้าถึงที่ใช้ร่วมกัน (SAS) เพื่อเชื่อมต่อ
ServicePrincipal	การเชื่อมต่อใช้การรับรองความถูกต้องแบบโครงร่างสําคัญของบริการเพื่อเชื่อมต่อ
WorkspaceIdentity	การเชื่อมต่อใช้การรับรองความถูกต้องข้อมูลประจําตัวของพื้นที่ทํางานเพื่อเชื่อมต่อ
KeyPair	การเชื่อมต่อใช้การตรวจสอบความถูกต้องของการจับคู่คีย์เพื่อเชื่อมต่อ

ErrorRelatedResource

วัตถุ

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

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

ErrorResponse

วัตถุ

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

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

ErrorResponseDetails

วัตถุ

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

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

ListConnectionDetails

วัตถุ

รายละเอียดการเชื่อมต่อผลลัพธ์สําหรับการดําเนินการรายการ

ชื่อ	พิมพ์	คำอธิบาย
path	string	เส้นทางของการเชื่อมต่อ
type	string	ชนิดของการเชื่อมต่อ

ListConnectionsResponse

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri	string	URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
value	Connection[]: OnPremisesGatewayConnection[] OnPremisesGatewayPersonalConnection[] PersonalCloudConnection[] ShareableCloudConnection[] VirtualNetworkGatewayConnection[]	รายการของการเชื่อมต่อที่ส่งกลับ

ListCredentialDetails

วัตถุ

รายละเอียดข้อมูลประจําตัวส่งกลับเมื่อดึงข้อมูลการเชื่อมต่อ

ชื่อ	พิมพ์	คำอธิบาย
connectionEncryption	ConnectionEncryption	การตั้งค่าการเข้ารหัสลับการเชื่อมต่อที่ใช้ในระหว่างการทดสอบการเชื่อมต่อ
credentialType	CredentialType	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
singleSignOnType	SingleSignOnType	ชนิดการลงชื่อเข้าระบบครั้งเดียวของการเชื่อมต่อ
skipTestConnection	boolean	การเชื่อมต่อควรข้ามการเชื่อมต่อทดสอบในระหว่างการสร้างและอัปเดตหรือไม่ True - ข้ามการเชื่อมต่อการทดสอบ เท็จ - อย่าข้ามการเชื่อมต่อการทดสอบ

OnPremisesGatewayConnection

วัตถุ

การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กร

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectivityType	string: OnPremisesGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออปเจ็กต์เกตเวย์ของการเชื่อมต่อ
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

OnPremisesGatewayPersonalConnection

วัตถุ

การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กรส่วนบุคคล

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectivityType	string: OnPremisesGatewayPersonal	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออปเจ็กต์เกตเวย์ของการเชื่อมต่อ
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

PersonalCloudConnection

วัตถุ

การเชื่อมต่อที่เชื่อมต่อผ่านระบบคลาวด์และไม่สามารถแชร์ได้

ชื่อ	พิมพ์	คำอธิบาย
allowConnectionUsageInGateway	boolean	อนุญาตให้ใช้งานการเชื่อมต่อนี้กับเกตเวย์ข้อมูลภายในองค์กรหรือเกตเวย์ข้อมูล VNet
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectivityType	string: PersonalCloud	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

PrivacyLevel

การแจงนับ

การตั้งค่าระดับความเป็นส่วนตัวของการเชื่อมต่อ อาจมีการเพิ่มระดับความเป็นส่วนตัวเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
None	ไม่มีการกําหนดค่าการตั้งค่าระดับความเป็นส่วนตัว
Private	การเชื่อมต่อที่ตั้งค่าเป็นส่วนตัวประกอบด้วยข้อมูลที่สําคัญหรือเป็นความลับ ความสามารถในการมองเห็นสามารถจํากัดให้กับผู้ใช้ที่ได้รับอนุญาตได้ ข้อมูลจากการเชื่อมต่อส่วนตัวจะไม่พับเข้ากับการเชื่อมต่ออื่น ๆ รวมถึงการเชื่อมต่อส่วนตัวอื่น ๆ ด้วย
Organizational	การเชื่อมต่อที่ตั้งค่าเป็นองค์กรสามารถพับเป็นการเชื่อมต่อส่วนตัวและองค์กรอื่น ๆ ได้ พวกเขาไม่สามารถพับเข้ากับการเชื่อมต่อสาธารณะได้ การมองเห็นถูกตั้งค่าเป็นกลุ่มที่เชื่อถือได้
Public	ไฟล์ การเชื่อมต่ออินเทอร์เน็ต และข้อมูลในเวิร์กบุ๊กสามารถตั้งค่าเป็นสาธารณะได้ ข้อมูลสามารถพับในการเชื่อมต่ออื่น ๆ ได้ ทุกคนสามารถมองเห็นได้

ShareableCloudConnection

วัตถุ

การเชื่อมต่อที่เชื่อมต่อผ่านระบบคลาวด์

ชื่อ	พิมพ์	คำอธิบาย
allowConnectionUsageInGateway	boolean	อนุญาตให้ใช้งานการเชื่อมต่อนี้กับเกตเวย์ข้อมูลภายในองค์กรหรือเกตเวย์ข้อมูล VNet
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectivityType	string: ShareableCloud	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

SingleSignOnType

การแจงนับ

ชนิดการลงชื่อเข้าระบบครั้งเดียวของการเชื่อมต่อ อาจมีการเพิ่มการลงชื่อเข้าระบบครั้งเดียวเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
None	การเชื่อมต่อไม่ใช้การลงชื่อเข้าระบบครั้งเดียวเพื่อเชื่อมต่อ
Kerberos	การเชื่อมต่อใช้การลงชื่อเข้าระบบแบบครั้งเดียวของ Kerberos เพื่อเชื่อมต่อ
MicrosoftEntraID	การเชื่อมต่อใช้การลงชื่อเข้าระบบครั้งเดียวของ Microsoft Entra ID เพื่อเชื่อมต่อ
SecurityAssertionMarkupLanguage	การเชื่อมต่อใช้การลงชื่อเข้าระบบครั้งเดียว Assertion Markup Language (SAML) เพื่อเชื่อมต่อ
KerberosDirectQueryAndRefresh	การเชื่อมต่อใช้ Kerberos DirectQuery และการรีเฟรชการลงชื่อเข้าระบบครั้งเดียวเพื่อเชื่อมต่อ

VirtualNetworkGatewayConnection

วัตถุ

การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือน

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectivityType	string: VirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออปเจ็กต์เกตเวย์ของการเชื่อมต่อ
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

แชร์ผ่าน

Connections - List Connections

Permissions

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

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

Interface

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

การตอบสนอง

ตัวอย่าง

Example

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

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

คำจำกัดความ

ConnectionEncryption

ConnectivityType

CredentialType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ListConnectionDetails

ListConnectionsResponse

ListCredentialDetails

OnPremisesGatewayConnection

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ShareableCloudConnection

SingleSignOnType

VirtualNetworkGatewayConnection