Connections - Update Connection

บริการ:: Core

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

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

Permissions

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

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

Connection.ReadWrite.All

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

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

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

Interface

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

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

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

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

เนื้อความของคำขออาจเป็นหนึ่งในรายการต่อไปนี้

ชื่อ	คำอธิบาย
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	อัปเดตการเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือนการสตรีม
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
connectivityType	True	string: OnPremisesGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName		string	ชื่อที่แสดงของการเชื่อมต่อ ความยาวสูงสุดคือ 200 อักขระ
privacyLevel		PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateOnPremisesGatewayPersonalConnectionRequest

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
connectivityType	True	string: OnPremisesGatewayPersonal	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
privacyLevel		PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdatePersonalCloudConnectionRequest

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
connectivityType	True	string: PersonalCloud	ชนิดการเชื่อมต่อของการเชื่อมต่อ
allowConnectionUsageInGateway		boolean	อนุญาตให้ใช้งานการเชื่อมต่อนี้กับเกตเวย์ข้อมูลภายในองค์กรหรือเกตเวย์ข้อมูล VNet
credentialDetails		UpdateCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
privacyLevel		PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateShareableCloudConnectionRequest

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

UpdateStreamingVirtualNetworkGatewayConnectionRequest

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

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
connectivityType	True	string: StreamingVirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails		UpdateCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName		string	ชื่อที่แสดงของการเชื่อมต่อ ความยาวสูงสุดคือ 200 อักขระ
privacyLevel		PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateVirtualNetworkGatewayConnectionRequest

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
connectivityType	True	string: VirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails		UpdateCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName		string	ชื่อที่แสดงของการเชื่อมต่อ ความยาวสูงสุดคือ 200 อักขระ
privacyLevel		PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

การตอบสนอง

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

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. การดําเนินการสําเร็จ
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: EntityNotFound - ไม่พบทรัพยากรที่ร้องขอ ไม่เพียงพอ PermissionsToManageConnection - ผู้เรียกมีสิทธิ์ไม่เพียงพอที่จะจัดการการเชื่อมต่อนี้ DuplicateConnectionName - ชื่อการเชื่อมต่อถูกใช้งานอยู่แล้ว IncorrectCredentials - ไม่สามารถสร้างการเชื่อมต่อโดยใช้การป้อนข้อมูลข้อมูลประจําตัวได้ UpdateGatewayConnectionFailed - ไม่สามารถอัปเดตการเชื่อมต่อเกตเวย์ได้

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

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

429 Too Many Requests

ErrorResponse

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

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

EntityNotFound - ไม่พบทรัพยากรที่ร้องขอ
ไม่เพียงพอ PermissionsToManageConnection - ผู้เรียกมีสิทธิ์ไม่เพียงพอที่จะจัดการการเชื่อมต่อนี้
DuplicateConnectionName - ชื่อการเชื่อมต่อถูกใช้งานอยู่แล้ว
IncorrectCredentials - ไม่สามารถสร้างการเชื่อมต่อโดยใช้การป้อนข้อมูลข้อมูลประจําตัวได้
UpdateGatewayConnectionFailed - ไม่สามารถอัปเดตการเชื่อมต่อเกตเวย์ได้

ตัวอย่าง

On-premises gateway (personal mode) example

On-premises gateway example

Personal cloud example

Shareable cloud example

Streaming virtual network gateway example

Virtual network gateway example

On-premises gateway (personal mode) example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/ef8f408d-2ab7-4a18-b662-9251febda49c

{
  "connectivityType": "OnPremisesGatewayPersonal",
  "credentialDetails": {
    "credentials": {
      "credentialType": "WindowsWithoutImpersonation",
      "encryptedCredentials": "************************************"
    }
  }
}

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

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

{
  "id": "ef8f408d-2ab7-4a18-b662-9251febda49c",
  "gatewayId": "429a773e-5633-45ee-8584-a192bd79c16a",
  "connectivityType": "OnPremisesGatewayPersonal",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;reporting"
  },
  "privacyLevel": "Private",
  "credentialDetails": {
    "credentialType": "WindowsWithoutImpersonation",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

On-premises gateway example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/70b17680-48f1-4729-9df6-02576647dc3a

{
  "connectivityType": "OnPremisesGateway",
  "displayName": "ContosoSalesOnPremisesConnection",
  "credentialDetails": {
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "c6961028-1309-4183-9799-a0b0fa28a235",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

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

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

{
  "id": "70b17680-48f1-4729-9df6-02576647dc3a",
  "displayName": "ContosoSalesOnPremisesConnection",
  "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Windows",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Personal cloud example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/7a0369b2-58c4-4b67-b3f3-92156a95f1cd

{
  "connectivityType": "PersonalCloud",
  "privacyLevel": "Organizational"
}

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

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

{
  "id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "PersonalCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;finances"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "OAuth2",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Shareable cloud example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/fa968eee-8075-48f6-8c6d-41260ee1396d

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection"
}

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

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

{
  "id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
  "displayName": "ContosoCloudConnection",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;networks"
  },
  "privacyLevel": "Public",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": true
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Streaming virtual network gateway example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "StreamingVirtualNetworkGateway",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

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

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

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "StreamingVirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  },
  "myRole": "Owner"
}

Virtual network gateway example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "VirtualNetworkGateway",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

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

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

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

คำจำกัดความ

ชื่อ	คำอธิบาย
AnonymousCredentials	ข้อมูลประจําตัวสําหรับ CredentialType แบบไม่ระบุชื่อ
BasicCredentials	ข้อมูลประจําตัวสําหรับ CredentialType พื้นฐาน
ConnectionEncryption	ชนิดการเข้ารหัสลับการเชื่อมต่อของการเชื่อมต่อ อาจมีการเพิ่มค่าการเข้ารหัสลับการเชื่อมต่อเพิ่มเติมเมื่อเวลาผ่านไป
ConnectionRecency	แสดงรายละเอียดเงินคืนเกี่ยวกับการเชื่อมต่อ
ConnectionRole	บทบาทการเชื่อมต่อ บทบาทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
ConnectivityType	ชนิดการเชื่อมต่อของการเชื่อมต่อ ประเภทการเชื่อมต่อเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
CredentialType	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ อาจมีการเพิ่มชนิดข้อมูลประจําตัวเพิ่มเติมเมื่อเวลาผ่านไป
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
KeyCredentials	ข้อมูลประจําตัวสําหรับ Key CredentialType
KeyPairCredentials	ข้อมูลประจําตัวสําหรับ KeyPair CredentialType
KeyVaultSecretReference	การอ้างอิงไปยังข้อมูลลับที่จัดเก็บไว้ใน Azure Key Vault
ListConnectionDetails	รายละเอียดการเชื่อมต่อผลลัพธ์สําหรับการดําเนินการรายการ
ListCredentialDetails	รายละเอียดข้อมูลประจําตัวส่งกลับเมื่อดึงข้อมูลการเชื่อมต่อ
OnPremisesCredentialEntry	ID เกตเวย์และข้อมูลประจําตัวที่เข้ารหัสลับแบบอนุกรม
OnPremisesGatewayConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กร
OnPremisesGatewayCredentials	ข้อมูลประจําตัวสําหรับการรับรองความถูกต้องผ่านเกตเวย์ภายในองค์กร
OnPremisesGatewayPersonalConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลภายในองค์กรส่วนบุคคล
OnPremisesGatewayPersonalCredentials	ข้อมูลประจําตัวสําหรับการรับรองความถูกต้องผ่านเกตเวย์ภายในองค์กร (โหมดส่วนบุคคล)
PersonalCloudConnection	การเชื่อมต่อที่เชื่อมต่อผ่านระบบคลาวด์และไม่สามารถแชร์ได้
PrivacyLevel	การตั้งค่าระดับความเป็นส่วนตัวของการเชื่อมต่อ อาจมีการเพิ่มระดับความเป็นส่วนตัวเพิ่มเติมเมื่อเวลาผ่านไป
ServicePrincipalCredentials	ข้อมูลประจําตัวสําหรับ ServicePrincipal CredentialType
ShareableCloudConnection	การเชื่อมต่อที่เชื่อมต่อผ่านระบบคลาวด์
SharedAccessSignatureCredentials	ข้อมูลประจําตัวสําหรับ SharedAccessSignature CredentialType
SingleSignOnType	ชนิดการลงชื่อเข้าระบบครั้งเดียวของการเชื่อมต่อ อาจมีการเพิ่มการลงชื่อเข้าระบบครั้งเดียวเพิ่มเติมเมื่อเวลาผ่านไป
StreamingVirtualNetworkGatewayConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือนการสตรีม
UpdateCredentialDetails	การป้อนข้อมูลรายละเอียดข้อมูลประจําตัวสําหรับการอัปเดตการเชื่อมต่อ
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	การป้อนข้อมูลรายละเอียดข้อมูลประจําตัวสําหรับการอัปเดตการเชื่อมต่อเกตเวย์ภายในองค์กร
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	การป้อนข้อมูลรายละเอียดข้อมูลประจําตัวสําหรับการอัปเดตการเชื่อมต่อเกตเวย์ภายในองค์กร
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	อัปเดตการเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือนการสตรีม
UpdateVirtualNetworkGatewayConnectionRequest
VirtualNetworkGatewayConnection	การเชื่อมต่อที่เชื่อมต่อผ่านเกตเวย์ข้อมูลเครือข่ายเสมือน
WindowsCredentials	ข้อมูลประจําตัวสําหรับข้อมูลประจําตัว Windows CredentialType
WindowsWithoutImpersonationCredentials	ข้อมูลประจําตัวสําหรับ WindowsWithoutImpersonation CredentialType
WorkspaceIdentityCredentials	ข้อมูลประจําตัวสําหรับ WorkspaceIdentity CredentialType

AnonymousCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ CredentialType แบบไม่ระบุชื่อ

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: Anonymous	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ

BasicCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ CredentialType พื้นฐาน

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: Basic	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
password	string	รหัสผ่าน ใช้รหัสผ่านหรือรหัสผ่านการรีเฟรช คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน
passwordReference	KeyVaultSecretReference	การอ้างอิงถึงรหัสผ่านที่จัดเก็บไว้ใน Azure Key Vault ใช้รหัสผ่านหรือรหัสผ่านการรีเฟรช คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน
username	string	ชื่อผู้ใช้

ConnectionEncryption

การแจงนับ

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

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

ConnectionRecency

วัตถุ

แสดงรายละเอียดเงินคืนเกี่ยวกับการเชื่อมต่อ

ชื่อ	พิมพ์	คำอธิบาย
createdDateTime	string (date-time)	ประทับเวลาเมื่อการเชื่อมต่อถูกสร้างขึ้นใน UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
lastBoundDateTime	string (date-time)	ประทับเวลาเมื่อมีการผูกการเชื่อมต่อล่าสุดกับรายการใด ๆ ใน UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
lastCredentialUsedDateTime	string (date-time)	ประทับเวลาเมื่อมีการใช้ข้อมูลประจําตัวการเชื่อมต่อล่าสุดใน UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
myLastBoundDateTime	string (date-time)	ประทับเวลาเมื่อมีการผูกการเชื่อมต่อไปยังรายการใด ๆ ล่าสุดโดยผู้ใช้ที่เรียกใช้ใน UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
myLastCredentialUsedDateTime	string (date-time)	ประทับเวลาเมื่อมีการใช้ข้อมูลประจําตัวการเชื่อมต่อล่าสุดโดยผู้ใช้ที่เรียกใช้ใน UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ

ConnectionRole

การแจงนับ

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

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

ConnectivityType

การแจงนับ

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

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

CredentialType

การแจงนับ

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

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

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

KeyCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ Key CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: Key	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
key	string	กุญแจ ใช้คีย์หรือ keyReference คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน
keyReference	KeyVaultSecretReference	การอ้างอิงถึงคีย์ที่จัดเก็บไว้ใน Azure Key Vault ใช้คีย์หรือ keyReference คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน

KeyPairCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ KeyPair CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: KeyPair	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
identifier	string	รหัสสําหรับคีย์
passphrase	string	วลีรหัสผ่านสําหรับคีย์ส่วนตัวถ้ามีการเข้ารหัสลับคีย์ส่วนตัว
privateKey	string	คีย์ส่วนตัวตามมาตรฐาน PKCS #8

KeyVaultSecretReference

วัตถุ

การอ้างอิงไปยังข้อมูลลับที่จัดเก็บไว้ใน Azure Key Vault

ชื่อ	พิมพ์	คำอธิบาย
connectionId	string (uuid)	รหัสการเชื่อมต่อของการเชื่อมต่อชุดเก็บคีย์
secretName	string	ชื่อของข้อมูลลับในชุดเก็บคีย์
version	string	เวอร์ชันของข้อมูลลับในชุดเก็บคีย์

ListConnectionDetails

วัตถุ

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

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

ListCredentialDetails

วัตถุ

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

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

OnPremisesCredentialEntry

วัตถุ

ID เกตเวย์และข้อมูลประจําตัวที่เข้ารหัสลับแบบอนุกรม

ชื่อ	พิมพ์	คำอธิบาย
encryptedCredentials	string	.json เข้ารหัสลับแบบอนุกรมของรายการคู่ค่าชื่อ ชื่อคือชื่อข้อมูลประจําตัวและค่าเป็นค่าข้อมูลประจําตัว การเข้ารหัสลับจะดําเนินการโดยใช้อัลกอริทึมการเข้ารหัสลับ Rivest-Shamir-Adleman (RSA) ด้วยคีย์สาธารณะของสมาชิกเกตเวย์ภายในองค์กร
gatewayId	string (uuid)	ID ออปเจ็กต์ของเกตเวย์

OnPremisesGatewayConnection

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectionRecency	ConnectionRecency	รายละเอียดการดําเนินการเกี่ยวกับการเชื่อมต่อ
connectivityType	string: OnPremisesGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออบเจ็กต์เกตเวย์ที่ทําการเชื่อมต่อ สําหรับการเชื่อมต่อระบบคลาวด์ นี่คือ ID เกตเวย์เสมือน
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
myRole	ConnectionRole	บทบาทที่มีผลบังคับใช้ของชื่อหลักบนการเชื่อมต่อ เมื่อโครงร่างสําคัญเป็นส่วนหนึ่งของกลุ่มความปลอดภัยหลายกลุ่มที่มีบทบาทที่แตกต่างกัน บทบาทสูงสุดจะถูกส่งกลับ ถ้าองค์ประกอบหลักของไม่มีบทบาทในการเชื่อมต่อ คุณสมบัตินี้จะไม่ถูกส่งกลับ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

OnPremisesGatewayCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับการรับรองความถูกต้องผ่านเกตเวย์ภายในองค์กร

ชื่อ	พิมพ์	คำอธิบาย
credentialType	CredentialType	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
values	OnPremisesCredentialEntry[]	ส่วนข้อมูลข้อมูลประจําตัวที่จะส่งไปยังเกตเวย์ภายในองค์กร

OnPremisesGatewayPersonalConnection

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectionRecency	ConnectionRecency	รายละเอียดการดําเนินการเกี่ยวกับการเชื่อมต่อ
connectivityType	string: OnPremisesGatewayPersonal	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออบเจ็กต์เกตเวย์ที่ทําการเชื่อมต่อ สําหรับการเชื่อมต่อระบบคลาวด์ นี่คือ ID เกตเวย์เสมือน
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
myRole	ConnectionRole	บทบาทที่มีผลบังคับใช้ของชื่อหลักบนการเชื่อมต่อ เมื่อโครงร่างสําคัญเป็นส่วนหนึ่งของกลุ่มความปลอดภัยหลายกลุ่มที่มีบทบาทที่แตกต่างกัน บทบาทสูงสุดจะถูกส่งกลับ ถ้าองค์ประกอบหลักของไม่มีบทบาทในการเชื่อมต่อ คุณสมบัตินี้จะไม่ถูกส่งกลับ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

OnPremisesGatewayPersonalCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับการรับรองความถูกต้องผ่านเกตเวย์ภายในองค์กร (โหมดส่วนบุคคล)

ชื่อ	พิมพ์	คำอธิบาย
credentialType	CredentialType	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
encryptedCredentials	string	.json เข้ารหัสลับแบบอนุกรมของรายการคู่ค่าชื่อ ชื่อคือชื่อข้อมูลประจําตัวและค่าเป็นค่าข้อมูลประจําตัว การเข้ารหัสลับจะดําเนินการโดยใช้อัลกอริทึมการเข้ารหัสลับ Rivest-Shamir-Adleman (RSA) ด้วยคีย์สาธารณะของเกตเวย์ภายในองค์กร

PersonalCloudConnection

วัตถุ

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

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

PrivacyLevel

การแจงนับ

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

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

ServicePrincipalCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ ServicePrincipal CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: ServicePrincipal	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
servicePrincipalClientId	string (uuid)	ID ไคลเอ็นต์ของบริการหลัก
servicePrincipalSecret	string	ความลับของโครงร่างสําคัญของบริการ ใช้ servicePrincipalSecret หรือ servicePrincipalSecretReference คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน
servicePrincipalSecretReference	KeyVaultSecretReference	การอ้างอิงไปยังข้อมูลลับของบริการหลักที่จัดเก็บไว้ในชุดเก็บคีย์ของ Azure ใช้ servicePrincipalSecret หรือ servicePrincipalSecretReference คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน
tenantId	string (uuid)	รหัสผู้เช่าของโครงร่างสําคัญของบริการ

ShareableCloudConnection

วัตถุ

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

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

SharedAccessSignatureCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ SharedAccessSignature CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: SharedAccessSignature	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
token	string	โทเค็น ใช้โทเค็นหรือ tokenReference คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน
tokenReference	KeyVaultSecretReference	การอ้างอิงไปยังโทเค็นที่จัดเก็บไว้ใน Azure Key Vault ใช้โทเค็นหรือ tokenReference คุณไม่สามารถใช้ทั้งสองอย่างในเวลาเดียวกัน

SingleSignOnType

การแจงนับ

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

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

StreamingVirtualNetworkGatewayConnection

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectionRecency	ConnectionRecency	รายละเอียดการดําเนินการเกี่ยวกับการเชื่อมต่อ
connectivityType	string: StreamingVirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออปเจ็กต์เกตเวย์ของการเชื่อมต่อ
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
myRole	ConnectionRole	บทบาทที่มีผลบังคับใช้ของชื่อหลักบนการเชื่อมต่อ เมื่อโครงร่างสําคัญเป็นส่วนหนึ่งของกลุ่มความปลอดภัยหลายกลุ่มที่มีบทบาทที่แตกต่างกัน บทบาทสูงสุดจะถูกส่งกลับ ถ้าองค์ประกอบหลักของไม่มีบทบาทในการเชื่อมต่อ คุณสมบัตินี้จะไม่ถูกส่งกลับ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateCredentialDetails

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
connectionEncryption	ConnectionEncryption	การตั้งค่าการเข้ารหัสลับการเชื่อมต่อที่ใช้ในระหว่างการทดสอบการเชื่อมต่อ
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	ข้อมูลประจําตัวของการเชื่อมต่อ
singleSignOnType	SingleSignOnType	ชนิดการลงชื่อเข้าระบบครั้งเดียวของการเชื่อมต่อ
skipTestConnection	boolean	การเชื่อมต่อควรข้ามการเชื่อมต่อทดสอบในระหว่างการสร้างและอัปเดตหรือไม่ True - ข้ามการเชื่อมต่อการทดสอบ เท็จ - อย่าข้ามการเชื่อมต่อการทดสอบ

UpdateOnPremisesGatewayConnectionRequest

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
connectivityType	string: OnPremisesGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ ความยาวสูงสุดคือ 200 อักขระ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateOnPremisesGatewayCredentialDetails

วัตถุ

การป้อนข้อมูลรายละเอียดข้อมูลประจําตัวสําหรับการอัปเดตการเชื่อมต่อเกตเวย์ภายในองค์กร

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

UpdateOnPremisesGatewayPersonalConnectionRequest

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
connectivityType	string: OnPremisesGatewayPersonal	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateOnPremisesGatewayPersonalCredentialDetails

วัตถุ

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

UpdatePersonalCloudConnectionRequest

วัตถุ

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

UpdateShareableCloudConnectionRequest

วัตถุ

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

UpdateStreamingVirtualNetworkGatewayConnectionRequest

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
connectivityType	string: StreamingVirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	UpdateCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ ความยาวสูงสุดคือ 200 อักขระ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

UpdateVirtualNetworkGatewayConnectionRequest

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
connectivityType	string: VirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	UpdateCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ ความยาวสูงสุดคือ 200 อักขระ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

VirtualNetworkGatewayConnection

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
connectionDetails	ListConnectionDetails	รายละเอียดการเชื่อมต่อของการเชื่อมต่อ
connectionRecency	ConnectionRecency	รายละเอียดการดําเนินการเกี่ยวกับการเชื่อมต่อ
connectivityType	string: VirtualNetworkGateway	ชนิดการเชื่อมต่อของการเชื่อมต่อ
credentialDetails	ListCredentialDetails	รายละเอียดข้อมูลประจําตัวของการเชื่อมต่อ
displayName	string	ชื่อที่แสดงของการเชื่อมต่อ
gatewayId	string (uuid)	ID ออบเจ็กต์เกตเวย์ที่ทําการเชื่อมต่อ สําหรับการเชื่อมต่อระบบคลาวด์ นี่คือ ID เกตเวย์เสมือน
id	string (uuid)	ID ออปเจ็กต์ของการเชื่อมต่อ
myRole	ConnectionRole	บทบาทที่มีผลบังคับใช้ของชื่อหลักบนการเชื่อมต่อ เมื่อโครงร่างสําคัญเป็นส่วนหนึ่งของกลุ่มความปลอดภัยหลายกลุ่มที่มีบทบาทที่แตกต่างกัน บทบาทสูงสุดจะถูกส่งกลับ ถ้าองค์ประกอบหลักของไม่มีบทบาทในการเชื่อมต่อ คุณสมบัตินี้จะไม่ถูกส่งกลับ
privacyLevel	PrivacyLevel	ระดับความเป็นส่วนตัวของการเชื่อมต่อ

WindowsCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับข้อมูลประจําตัว Windows CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: Windows	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ
password	string	รหัสผ่าน
username	string	ชื่อผู้ใช้

WindowsWithoutImpersonationCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ WindowsWithoutImpersonation CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: WindowsWithoutImpersonation	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ

WorkspaceIdentityCredentials

วัตถุ

ข้อมูลประจําตัวสําหรับ WorkspaceIdentity CredentialType

ชื่อ	พิมพ์	คำอธิบาย
credentialType	string: WorkspaceIdentity	ชนิดข้อมูลประจําตัวของการเชื่อมต่อ