Connections - Create Connection

Layanan:

Core

Versi API:

v1

Membuat koneksi.
Untuk mengenkripsi kredensial, lihat Mengonfigurasi kredensial secara terprogram.

Permissions

• Jika membuat koneksi gateway, pemanggil harus memiliki izin untuk gateway..
• Perwakilan Layanan harus memiliki izin yang diberikan oleh administrator Fabric. Untuk informasi selengkapnya, lihat: Perwakilan layanan dapat membuat ruang kerja, koneksi, dan alur penyebaran.

Cakupan yang Didelegasikan yang Diperlukan

Connection.ReadWrite.All

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identity	Support
User	Yes
perwakilan Layanan dan identitas terkelola	Yes

Interface

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

Isi Permintaan

Isi permintaan dapat berupa salah satu hal berikut:

Nama	Deskripsi
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Nama	Diperlukan	Jenis	Deskripsi
connectionDetails	True	CreateConnectionDetails	Detail koneksi koneksi.
connectivityType	True	string: ShareableCloud	Jenis konektivitas koneksi.
credentialDetails	True	CreateCredentialDetails	Detail kredensial koneksi.
displayName	True	string	Nama tampilan koneksi. Panjang maksimum adalah 200 karakter.
allowConnectionUsageInGateway		boolean	Izinkan koneksi ini digunakan dengan gateway data lokal atau gateway data VNet.
privacyLevel		PrivacyLevel	(Opsional) Tingkat privasi koneksi. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'Organisasi'.

CreateOnPremisesConnectionRequest

Nama	Diperlukan	Jenis	Deskripsi
connectionDetails	True	CreateConnectionDetails	Detail koneksi koneksi.
connectivityType	True	string: OnPremisesGateway	Jenis konektivitas koneksi.
credentialDetails	True	CreateOnPremisesCredentialDetails	Detail kredensial koneksi.
displayName	True	string	Nama tampilan koneksi. Panjang maksimum adalah 200 karakter.
gatewayId	True	string (uuid)	ID objek gateway utama gateway lokal tempat koneksi dibuat.
privacyLevel		PrivacyLevel	(Opsional) Tingkat privasi koneksi. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'Organisasi'.

CreateVirtualNetworkGatewayConnectionRequest

Nama	Diperlukan	Jenis	Deskripsi
connectionDetails	True	CreateConnectionDetails	Detail koneksi koneksi.
connectivityType	True	string: VirtualNetworkGateway	Jenis konektivitas koneksi.
credentialDetails	True	CreateCredentialDetails	Detail kredensial koneksi.
displayName	True	string	Nama tampilan koneksi. Panjang maksimum adalah 200 karakter.
gatewayId	True	string (uuid)	ID objek gateway jaringan virtual tempat koneksi dibuat.
privacyLevel		PrivacyLevel	(Opsional) Tingkat privasi koneksi. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'Organisasi'.

Respons

Nama	Jenis	Deskripsi
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Operasi berhasil.
Other Status Codes	ErrorResponse	Kode kesalahan umum: DuplicateConnectionName - Nama koneksi sudah digunakan. InvalidConnectionDetails - Input ConnectionDetails yang disediakan tidak valid. InvalidCredentialDetails - Input CredentialDetails yang disediakan tidak valid. IncorrectCredentials - Gagal membuat koneksi menggunakan input Kredensial. CreateGatewayConnectionFailed - Gagal membuat koneksi gateway.

Contoh

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Permintaan sampel

HTTP

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

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "********"
    }
  }
}

Respon sampel

Kode status:

201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

On-premises gateway example

Permintaan sampel

HTTP

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

{
  "connectivityType": "OnPremisesGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoOnPremisesConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "55226bab-5024-4b72-9716-6dc8ef3a97fe",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Respon sampel

Kode status:

201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoOnPremisesConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Virtual network gateway example

Permintaan sampel

HTTP

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

{
  "connectivityType": "VirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "*********"
    }
  }
}

Respon sampel

Kode status:

201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  }
}

Definisi

Nama	Deskripsi
AnonymousCredentials	Kredensial untuk Anonymous CredentialType.
BasicCredentials	Kredensial untuk Basic CredentialType.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter untuk boolean dataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter untuk dataType tanggal.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter untuk dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter untuk dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter untuk dataType durasi.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter untuk dataType angka.
ConnectionDetailsTextParameter	ConnectionDetailsParameter untuk dataType teks.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter untuk time dataType.
ConnectionEncryption	Jenis enkripsi koneksi koneksi. Nilai enkripsi koneksi tambahan dapat ditambahkan dari waktu ke waktu.
ConnectivityType	Jenis konektivitas koneksi. Jenis konektivitas tambahan dapat ditambahkan dari waktu ke waktu.
CreateCloudConnectionRequest
CreateConnectionDetails	Input detail koneksi untuk membuat operasi.
CreateCredentialDetails	Input detail info masuk untuk membuat koneksi.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Input detail info masuk untuk membuat koneksi gateway lokal.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Jenis kredensial koneksi. Jenis kredensial tambahan dapat ditambahkan dari waktu ke waktu.
DataType	Jenis data nilai parameter pembuatan koneksi. Nilai jenis data tambahan dapat ditambahkan dari waktu ke waktu.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
KeyCredentials	Kredensial untuk Key CredentialType.
ListConnectionDetails	Output detail koneksi untuk operasi daftar.
ListCredentialDetails	Detail kredensial dikembalikan saat mengambil koneksi.
OnPremisesCredentialEntry	ID gateway dan kredensial serial terenkripsinya.
OnPremisesGatewayConnection	Koneksi yang tersambung melalui gateway data lokal.
OnPremisesGatewayCredentials	Kredensial untuk mengautentikasi melalui gateway lokal.
OnPremisesGatewayPersonalConnection	Koneksi yang tersambung melalui gateway data lokal pribadi.
PersonalCloudConnection	Koneksi yang tersambung melalui cloud dan tidak dapat dibagikan.
PrivacyLevel	Pengaturan tingkat privasi koneksi. Tingkat privasi tambahan dapat ditambahkan dari waktu ke waktu.
ServicePrincipalCredentials	Kredensial untuk ServicePrincipal CredentialType.
ShareableCloudConnection	Koneksi yang terhubung melalui cloud.
SharedAccessSignatureCredentials	Kredensial untuk SharedAccessSignature CredentialType.
SingleSignOnType	Jenis akses menyeluruh koneksi. Jenis akses menyeluruh tambahan dapat ditambahkan dari waktu ke waktu.
VirtualNetworkGatewayConnection	Koneksi yang tersambung melalui gateway data jaringan virtual.
WindowsCredentials	Kredensial untuk Windows CredentialType.
WindowsWithoutImpersonationCredentials	Kredensial untuk WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Kredensial untuk WorkspaceIdentity CredentialType.

AnonymousCredentials

Objek

Kredensial untuk Anonymous CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: Anonymous	Jenis kredensial koneksi.

BasicCredentials

Objek

Kredensial untuk Basic CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: Basic	Jenis kredensial koneksi.
password	string	Kata sandi.
username	string	Nama pengguna.

ConnectionDetailsBooleanParameter

Objek

ConnectionDetailsParameter untuk boolean dataType.

Nama	Jenis	Deskripsi
dataType	string: Boolean	Jenis data parameter.
name	string	Nama parameter.
value	boolean	Nilai boolean.

ConnectionDetailsDateParameter

Objek

ConnectionDetailsParameter untuk dataType tanggal.

Nama	Jenis	Deskripsi
dataType	string: Date	Jenis data parameter.
name	string	Nama parameter.
value	string (date)	Nilai tanggal menggunakan formatMM-DD YYYY.

ConnectionDetailsDateTimeParameter

Objek

ConnectionDetailsParameter untuk dateTime dataType.

Nama	Jenis	Deskripsi
dataType	string: DateTime	Jenis data parameter.
name	string	Nama parameter.
value	string (date-time)	Nilai waktu tanggal menggunakan YYYY-MM-DDTHH:mm:ss. Format FFFZ.

ConnectionDetailsDateTimeZoneParameter

Objek

ConnectionDetailsParameter untuk dateTimeZone dataType.

Nama	Jenis	Deskripsi
dataType	string: DateTimeZone	Jenis data parameter.
name	string	Nama parameter.
value	string (date-time-offset)	Nilai zona waktu tanggal menggunakan YYYY-MM-DDTHH:mm:ss. Format FFF±hh:mm.

ConnectionDetailsDurationParameter

Objek

ConnectionDetailsParameter untuk dataType durasi.

Nama	Jenis	Deskripsi
dataType	string: Duration	Jenis data parameter.
name	string	Nama parameter.
value	string (time-span)	Nilai durasi menggunakan format [-]P(n)DT(n)H(n)M(n)S. Misalnya: P3DT4H30M10S (selama 3 hari, 4 jam, 30 menit, dan 10 detik).

ConnectionDetailsNumberParameter

Objek

ConnectionDetailsParameter untuk dataType angka.

Nama	Jenis	Deskripsi
dataType	string: Number	Jenis data parameter.
name	string	Nama parameter.
value	number	Nilai angka.

ConnectionDetailsTextParameter

Objek

ConnectionDetailsParameter untuk dataType teks.

Nama	Jenis	Deskripsi
dataType	string: Text	Jenis data parameter.
name	string	Nama parameter.
value	string	Nilai teks.

ConnectionDetailsTimeParameter

Objek

ConnectionDetailsParameter untuk time dataType.

Nama	Jenis	Deskripsi
dataType	string: Time	Jenis data parameter.
name	string	Nama parameter.
value	string (time)	Nilai waktu menggunakan HH:mm:ss. Format FFFZ.

ConnectionEncryption

Enumeration

Jenis enkripsi koneksi koneksi. Nilai enkripsi koneksi tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Encrypted	Upaya koneksi dilakukan menggunakan koneksi terenkripsi.
Any	Upaya koneksi pertama kali dilakukan menggunakan koneksi terenkripsi, lalu kembali ke koneksi yang tidak terenkripsi jika tidak berhasil.
NotEncrypted	Upaya koneksi dilakukan menggunakan koneksi yang tidak terenkripsi.

ConnectivityType

Enumeration

Jenis konektivitas koneksi. Jenis konektivitas tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
ShareableCloud	Koneksi terhubung melalui cloud dan dapat dibagikan dengan orang lain.
PersonalCloud	Koneksi terhubung melalui cloud dan tidak dapat dibagikan dengan orang lain.
OnPremisesGateway	Koneksi tersambung melalui gateway data lokal.
OnPremisesGatewayPersonal	Koneksi tersambung melalui gateway data lokal pribadi.
VirtualNetworkGateway	Koneksi tersambung melalui gateway data jaringan virtual.
Automatic	Koneksi terhubung melalui cloud menggunakan koneksi data implisit. Opsi ini hanya tersedia untuk skenario tertentu seperti model semantik yang menggunakan Single Sign-On (SSO)."
None	Koneksi tidak terikat

CreateCloudConnectionRequest

Objek

Nama	Jenis	Deskripsi
allowConnectionUsageInGateway	boolean	Izinkan koneksi ini digunakan dengan gateway data lokal atau gateway data VNet.
connectionDetails	CreateConnectionDetails	Detail koneksi koneksi.
connectivityType	string: ShareableCloud	Jenis konektivitas koneksi.
credentialDetails	CreateCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi. Panjang maksimum adalah 200 karakter.
privacyLevel	PrivacyLevel	(Opsional) Tingkat privasi koneksi. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'Organisasi'.

CreateConnectionDetails

Objek

Input detail koneksi untuk membuat operasi.

Nama	Jenis	Deskripsi
creationMethod	string	Metode pembuatan yang digunakan untuk membuat koneksi. Untuk daftar metode pembuatan, gunakan LISTSupportedConnectionTypes API.
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Daftar parameter koneksi. Untuk daftar parameter untuk setiap metode pembuatan, gunakan LISTSupportedConnectionTypes API.
type	string	Jenis koneksi.

CreateCredentialDetails

Objek

Input detail info masuk untuk membuat koneksi.

Nama	Jenis	Deskripsi
connectionEncryption	ConnectionEncryption	(Opsional) Pengaturan enkripsi koneksi yang digunakan selama koneksi pengujian. Ketika tidak ada nilai yang diteruskan, koneksi tidak dienkripsi.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Kredensial koneksi.
singleSignOnType	SingleSignOnType	(Opsional) Jenis akses menyeluruh koneksi. Ketika tidak ada nilai yang diteruskan, koneksi tidak menggunakan akses menyeluruh.
skipTestConnection	boolean	Apakah koneksi harus melewati koneksi pengujian selama pembuatan dan pembaruan. True - Lewati koneksi pengujian, False - Jangan lewati koneksi pengujian. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'False'.

CreateOnPremisesConnectionRequest

Objek

Nama	Jenis	Deskripsi
connectionDetails	CreateConnectionDetails	Detail koneksi koneksi.
connectivityType	string: OnPremisesGateway	Jenis konektivitas koneksi.
credentialDetails	CreateOnPremisesCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi. Panjang maksimum adalah 200 karakter.
gatewayId	string (uuid)	ID objek gateway utama gateway lokal tempat koneksi dibuat.
privacyLevel	PrivacyLevel	(Opsional) Tingkat privasi koneksi. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'Organisasi'.

CreateOnPremisesCredentialDetails

Objek

Input detail info masuk untuk membuat koneksi gateway lokal.

Nama	Jenis	Deskripsi
connectionEncryption	ConnectionEncryption	(Opsional) Pengaturan enkripsi koneksi yang digunakan selama koneksi pengujian. Ketika tidak ada nilai yang diteruskan, koneksi tidak dienkripsi.
credentials	OnPremisesGatewayCredentials	Kredensial koneksi.
singleSignOnType	SingleSignOnType	(Opsional) Jenis akses menyeluruh koneksi. Ketika tidak ada nilai yang diteruskan, koneksi tidak menggunakan akses menyeluruh.
skipTestConnection	boolean	Apakah koneksi harus melewati koneksi pengujian selama pembuatan dan pembaruan. True - Lewati koneksi pengujian, False - Jangan lewati koneksi pengujian. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'False'.

CreateVirtualNetworkGatewayConnectionRequest

Objek

Nama	Jenis	Deskripsi
connectionDetails	CreateConnectionDetails	Detail koneksi koneksi.
connectivityType	string: VirtualNetworkGateway	Jenis konektivitas koneksi.
credentialDetails	CreateCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi. Panjang maksimum adalah 200 karakter.
gatewayId	string (uuid)	ID objek gateway jaringan virtual tempat koneksi dibuat.
privacyLevel	PrivacyLevel	(Opsional) Tingkat privasi koneksi. Ketika tidak ada nilai yang diteruskan, ini diatur ke 'Organisasi'.

CredentialType

Enumeration

Jenis kredensial koneksi. Jenis kredensial tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Windows	Koneksi menggunakan autentikasi Windows untuk menyambungkan. Hanya didukung untuk gateway lokal.
Anonymous	Koneksi menggunakan autentikasi anonim untuk menyambungkan.
Basic	Koneksi menggunakan autentikasi dasar untuk menyambungkan.
Key	Koneksi menggunakan autentikasi kunci untuk menyambungkan.
OAuth2	Koneksi menggunakan autentikasi OAuth 2.0 untuk menyambungkan.
WindowsWithoutImpersonation	Koneksi menggunakan autentikasi Windows (tanpa opsi untuk peniruan identitas) untuk menyambungkan. Hanya didukung untuk gateway lokal (mode pribadi).
SharedAccessSignature	Koneksi menggunakan autentikasi tanda tangan akses bersama (SAS) untuk menyambungkan.
ServicePrincipal	Koneksi menggunakan autentikasi perwakilan layanan untuk menyambungkan.
WorkspaceIdentity	Koneksi menggunakan autentikasi identitas ruang kerja untuk menyambungkan.

DataType

Enumeration

Jenis data nilai parameter pembuatan koneksi. Nilai jenis data tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Text	Gunakan teks sebagai nilai input parameter.
Number	Gunakan angka sebagai nilai input parameter (bilangan bulat atau titik pecahan).
Boolean	Gunakan boolean sebagai nilai input parameter. False - nilainya false, True - nilainya benar.
Duration	Gunakan durasi sebagai nilai input parameter, menggunakan format [-]P(n)DT(n)H(n)M(n)S. Misalnya: P3DT4H30M10S (selama 3 hari, 4 jam, 30 menit, dan 10 detik).
Date	Gunakan tanggal sebagai nilai input parameter, menggunakan formatMM-DD YYYY.
DateTime	Gunakan waktu tanggal sebagai nilai input parameter, menggunakan YYYY-MM-DDTHH:mm:ss. Format FFFZ.
DateTimeZone	Gunakan zona waktu tanggal sebagai nilai input parameter, menggunakan YYYY-MM-DDTHH:mm:ss. Format FFF±hh:mm.
Time	Gunakan waktu sebagai nilai input parameter, menggunakan HH:mm:ss. Format FFFZ.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

KeyCredentials

Objek

Kredensial untuk Key CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: Key	Jenis kredensial koneksi.
key	string	Kuncinya.

ListConnectionDetails

Objek

Output detail koneksi untuk operasi daftar.

Nama	Jenis	Deskripsi
path	string	Jalur koneksi.
type	string	Jenis koneksi.

ListCredentialDetails

Objek

Detail kredensial dikembalikan saat mengambil koneksi.

Nama	Jenis	Deskripsi
connectionEncryption	ConnectionEncryption	Pengaturan enkripsi koneksi yang digunakan selama koneksi pengujian.
credentialType	CredentialType	Jenis kredensial koneksi.
singleSignOnType	SingleSignOnType	Jenis akses menyeluruh koneksi.
skipTestConnection	boolean	Apakah koneksi harus melewati koneksi pengujian selama pembuatan dan pembaruan. True - Lewati koneksi pengujian, False - Jangan lewati koneksi pengujian.

OnPremisesCredentialEntry

Objek

ID gateway dan kredensial serial terenkripsinya.

Nama	Jenis	Deskripsi
encryptedCredentials	string	.json serial terenkripsi dari daftar pasangan nilai nama. Nama adalah nama dan nilai kredensial adalah nilai kredensial. Enkripsi dilakukan menggunakan algoritma enkripsi Rivest-Shamir-Adleman (RSA) dengan kunci publik anggota gateway lokal.
gatewayId	string (uuid)	ID objek gateway.

OnPremisesGatewayConnection

Objek

Koneksi yang tersambung melalui gateway data lokal.

Nama	Jenis	Deskripsi
connectionDetails	ListConnectionDetails	Detail koneksi koneksi.
connectivityType	string: OnPremisesGateway	Jenis konektivitas koneksi.
credentialDetails	ListCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi.
gatewayId	string (uuid)	ID objek gateway koneksi.
id	string (uuid)	ID objek koneksi.
privacyLevel	PrivacyLevel	Tingkat privasi koneksi.

OnPremisesGatewayCredentials

Objek

Kredensial untuk mengautentikasi melalui gateway lokal.

Nama	Jenis	Deskripsi
credentialType	CredentialType	Jenis kredensial koneksi.
values	OnPremisesCredentialEntry[]	Payload kredensial untuk dikirim ke gateway lokal.

OnPremisesGatewayPersonalConnection

Objek

Koneksi yang tersambung melalui gateway data lokal pribadi.

Nama	Jenis	Deskripsi
connectionDetails	ListConnectionDetails	Detail koneksi koneksi.
connectivityType	string: OnPremisesGatewayPersonal	Jenis konektivitas koneksi.
credentialDetails	ListCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi.
gatewayId	string (uuid)	ID objek gateway koneksi.
id	string (uuid)	ID objek koneksi.
privacyLevel	PrivacyLevel	Tingkat privasi koneksi.

PersonalCloudConnection

Objek

Koneksi yang tersambung melalui cloud dan tidak dapat dibagikan.

Nama	Jenis	Deskripsi
allowConnectionUsageInGateway	boolean	Izinkan koneksi ini digunakan dengan gateway data lokal atau gateway data VNet.
connectionDetails	ListConnectionDetails	Detail koneksi koneksi.
connectivityType	string: PersonalCloud	Jenis konektivitas koneksi.
credentialDetails	ListCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi.
id	string (uuid)	ID objek koneksi.
privacyLevel	PrivacyLevel	Tingkat privasi koneksi.

PrivacyLevel

Enumeration

Pengaturan tingkat privasi koneksi. Tingkat privasi tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
None	Tidak ada pengaturan tingkat privasi yang dikonfigurasi.
Private	Koneksi diatur ke privat berisi informasi sensitif atau rahasia. Visibilitas dapat dibatasi untuk pengguna yang berwenang. Data dari koneksi privat tidak akan dilipat ke koneksi lain, termasuk koneksi privat lainnya.
Organizational	Koneksi yang diatur ke organisasi dapat dilipat ke koneksi privat dan organisasi lainnya. Mereka tidak dapat melipat ke koneksi publik. Visibilitas diatur ke grup tepercaya.
Public	File, koneksi internet, dan data buku kerja dapat diatur ke publik. Data dapat dilipat ke koneksi lain. Visibilitas tersedia untuk semua orang.

ServicePrincipalCredentials

Objek

Kredensial untuk ServicePrincipal CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: ServicePrincipal	Jenis kredensial koneksi.
servicePrincipalClientId	string (uuid)	ID klien dari perwakilan layanan.
servicePrincipalSecret	string	Rahasia perwakilan layanan.
tenantId	string (uuid)	ID penyewa dari perwakilan layanan.

ShareableCloudConnection

Objek

Koneksi yang terhubung melalui cloud.

Nama	Jenis	Deskripsi
allowConnectionUsageInGateway	boolean	Izinkan koneksi ini digunakan dengan gateway data lokal atau gateway data VNet.
connectionDetails	ListConnectionDetails	Detail koneksi koneksi.
connectivityType	string: ShareableCloud	Jenis konektivitas koneksi.
credentialDetails	ListCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi.
id	string (uuid)	ID objek koneksi.
privacyLevel	PrivacyLevel	Tingkat privasi koneksi.

SharedAccessSignatureCredentials

Objek

Kredensial untuk SharedAccessSignature CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: SharedAccessSignature	Jenis kredensial koneksi.
token	string	Token tersebut.

SingleSignOnType

Enumeration

Jenis akses menyeluruh koneksi. Jenis akses menyeluruh tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
None	Koneksi tidak menggunakan akses menyeluruh untuk menyambungkan.
Kerberos	Koneksi menggunakan akses menyeluruh Kerberos untuk menyambungkan.
MicrosoftEntraID	Koneksi menggunakan akses menyeluruh MICROSOFT Entra ID untuk menyambungkan.
SecurityAssertionMarkupLanguage	Koneksi menggunakan akses menyeluruh Security Assertion Markup Language (SAML) untuk menyambungkan.
KerberosDirectQueryAndRefresh	Koneksi menggunakan Kerberos DirectQuery dan Refresh akses menyeluruh untuk menyambungkan.

VirtualNetworkGatewayConnection

Objek

Koneksi yang tersambung melalui gateway data jaringan virtual.

Nama	Jenis	Deskripsi
connectionDetails	ListConnectionDetails	Detail koneksi koneksi.
connectivityType	string: VirtualNetworkGateway	Jenis konektivitas koneksi.
credentialDetails	ListCredentialDetails	Detail kredensial koneksi.
displayName	string	Nama tampilan koneksi.
gatewayId	string (uuid)	ID objek gateway koneksi.
id	string (uuid)	ID objek koneksi.
privacyLevel	PrivacyLevel	Tingkat privasi koneksi.

WindowsCredentials

Objek

Kredensial untuk Windows CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: Windows	Jenis kredensial koneksi.
password	string	Kata sandi.
username	string	Nama pengguna.

WindowsWithoutImpersonationCredentials

Objek

Kredensial untuk WindowsWithoutImpersonation CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: WindowsWithoutImpersonation	Jenis kredensial koneksi.

WorkspaceIdentityCredentials

Objek

Kredensial untuk WorkspaceIdentity CredentialType.

Nama	Jenis	Deskripsi
credentialType	string: WorkspaceIdentity	Jenis kredensial koneksi.