Connections - Create Connection

Hizmet:: Core

API Sürümü:: v1

Bir bağlantı oluşturur.
Kimlik bilgilerini şifrelemek için bkz. Kimlik bilgilerini program aracılığıyla yapılandırma.

Permissions

Ağ geçidi bağlantısı oluşturuyorsanız, çağıranın ağ geçidi için izinleri olmalıdır..
Hizmet Sorumluları, Doku yöneticisi tarafından verilen izne sahip olmalıdır. Daha fazla bilgi için bkz. Hizmet sorumluları çalışma alanları, bağlantılar ve dağıtım işlem hatları oluşturabilir.

Gerekli Temsilci Kapsamları

Connection.ReadWrite.All

Microsoft Entra tarafından desteklenen kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Identity	Support
User	Yes
Hizmet sorumlusu ve yönetilen kimlikler	Yes

Interface

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

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Name	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name	Gerekli	Tür	Description
connectionDetails	True	CreateConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	True	string: ShareableCloud	Bağlantının bağlantı türü.
credentialDetails	True	CreateCredentialDetails	Bağlantının kimlik bilgileri.
displayName	True	string	Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.
allowConnectionUsageInGateway		boolean	Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.
allowUsageInUserControlledCode		boolean	Bu bağlantının Not Defteri gibi kullanıcı tarafından denetlenen koda izin veren öğelerle kullanılmasına izin ver
privacyLevel		PrivacyLevel	(İsteğe bağlı) Bağlantının gizlilik düzeyi. Hiçbir değer geçirilmiyorsa, bu 'Kuruluş' olarak ayarlanır.

CreateOnPremisesConnectionRequest

Name	Gerekli	Tür	Description
connectionDetails	True	CreateConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	True	string: OnPremisesGateway	Bağlantının bağlantı türü.
credentialDetails	True	CreateOnPremisesCredentialDetails	Bağlantının kimlik bilgileri.
displayName	True	string	Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.
gatewayId	True	string (uuid)	Bağlantının oluşturulduğu şirket içi ağ geçidinin birincil ağ geçidinin nesne kimliği.
privacyLevel		PrivacyLevel	(İsteğe bağlı) Bağlantının gizlilik düzeyi. Hiçbir değer geçirilmiyorsa, bu 'Kuruluş' olarak ayarlanır.

CreateVirtualNetworkGatewayConnectionRequest

Name	Gerekli	Tür	Description
connectionDetails	True	CreateConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	True	string: VirtualNetworkGateway	Bağlantının bağlantı türü.
credentialDetails	True	CreateCredentialDetails	Bağlantının kimlik bilgileri.
displayName	True	string	Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.
gatewayId	True	string (uuid)	Bağlantının altında oluşturulduğu sanal ağ geçidinin nesne kimliği.
privacyLevel		PrivacyLevel	(İsteğe bağlı) Bağlantının gizlilik düzeyi. Hiçbir değer geçirilmiyorsa, bu 'Kuruluş' olarak ayarlanır.

Yanıtlar

Name Tür Description

201 Created

Name	Tür	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. İşlem başarılı oldu.
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: DuplicateConnectionName - Bağlantı adı zaten kullanımda. InvalidConnectionDetails - Sağlanan ConnectionDetails girişi geçerli değil. InvalidCredentialDetails - Sağlanan CredentialDetails girişi geçerli değil. IncorrectCredentials - Kimlik Bilgileri girişi kullanılarak bağlantı kurulamadı. CreateGatewayConnectionFailed - Ağ geçidi bağlantısı oluşturulamadı.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. İşlem başarılı oldu.

429 Too Many Requests

ErrorResponse

Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Retry-After üst bilgi döndürür.

Üst Bilgiler

Retry-After: integer

Other Status Codes

ErrorResponse

Yaygın hata kodları:

DuplicateConnectionName - Bağlantı adı zaten kullanımda.
InvalidConnectionDetails - Sağlanan ConnectionDetails girişi geçerli değil.
InvalidCredentialDetails - Sağlanan CredentialDetails girişi geçerli değil.
IncorrectCredentials - Kimlik Bilgileri girişi kullanılarak bağlantı kurulamadı.
CreateGatewayConnectionFailed - Ağ geçidi bağlantısı oluşturulamadı.

Örnekler

Cloud example

Cloud example with KeyPair credentials

On-premises gateway example

Virtual network gateway example

Cloud example

Örnek isteği

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",
      "passwordReference": {
        "connectionId": "4399ab2c-7551-4c0e-8aa7-18fc2f217626",
        "secretName": "some-secret"
      }
    }
  },
  "allowUsageInUserControlledCode": true
}

Örnek yanıt

Durum kodu:: 201

{
  "allowUsageInUserControlledCode": true,
  "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
  }
}

Cloud example with KeyPair credentials

Örnek isteği

HTTP

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

{
  "connectivityType": "ShareableCloud",
  "displayName": "SnowflakeCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "warehouse",
        "value": "snowflake-warehouse"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "KeyPair",
      "identifier": "admin",
      "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ...\\n-----END ENCRYPTED PRIVATE KEY-----",
      "passphrase": "********"
    }
  }
}

Örnek yanıt

Durum kodu:: 201

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

On-premises gateway example

Örnek isteği

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": "************************************"
        }
      ]
    }
  }
}

Örnek yanıt

Durum kodu:: 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

Örnek isteği

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": "*********"
    }
  }
}

Örnek yanıt

Durum kodu:: 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
  }
}

Tanımlar

Name	Description
AnonymousCredentials	Anonim CredentialType için kimlik bilgileri.
BasicCredentials	Temel CredentialType için kimlik bilgileri.
ConnectionDetailsBooleanParameter	Boole dataType için ConnectionDetailsParameter.
ConnectionDetailsDateParameter	Date dataType için ConnectionDetailsParameter.
ConnectionDetailsDateTimeParameter	dateTime dataType için ConnectionDetailsParameter.
ConnectionDetailsDateTimeZoneParameter	dateTimeZone dataType için ConnectionDetailsParameter.
ConnectionDetailsDurationParameter	DataType süresi için ConnectionDetailsParameter.
ConnectionDetailsNumberParameter	dataType sayısı için ConnectionDetailsParameter.
ConnectionDetailsTextParameter	dataType metni için ConnectionDetailsParameter.
ConnectionDetailsTimeParameter	Time dataType için ConnectionDetailsParameter.
ConnectionEncryption	Bağlantının bağlantı şifreleme türü. Zaman içinde ek bağlantı şifreleme değerleri eklenebilir.
ConnectivityType	Bağlantının bağlantı türü. Zaman içinde ek bağlantı türleri eklenebilir.
CreateCloudConnectionRequest
CreateConnectionDetails	Bağlantı, oluşturma işlemleri için girişi ayrıntılarıyla açıklar.
CreateCredentialDetails	Kimlik bilgisi, bağlantı oluşturmak için giriş bilgilerini gösterir.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Şirket içi ağ geçidi bağlantısı oluşturmaya yönelik kimlik bilgisi ayrıntıları girişi.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Bağlantının kimlik bilgisi türü. Zaman içinde ek kimlik bilgisi türleri eklenebilir.
DataType	Bağlantı oluşturma parametre değerinin veri türü. Zaman içinde ek veri türü değerleri eklenebilir.
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
KeyCredentials	Key CredentialType için kimlik bilgileri.
KeyPairCredentials	KeyPair CredentialType için kimlik bilgileri.
KeyVaultSecretReference	Azure Key Vault'ta depolanan bir gizli diziye başvuru.
ListConnectionDetails	Liste işlemleri için bağlantı ayrıntıları çıktısı.
ListCredentialDetails	Bağlantı getirilirken döndürülen kimlik bilgisi ayrıntıları.
OnPremisesCredentialEntry	Ağ geçidi kimliği ve şifrelenmiş serileştirilmiş kimlik bilgileri.
OnPremisesGatewayConnection	Şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.
OnPremisesGatewayCredentials	Şirket içi ağ geçidinde kimlik doğrulaması için kimlik bilgileri.
OnPremisesGatewayPersonalConnection	Kişisel şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.
PersonalCloudConnection	Bulut üzerinden bağlanan ve paylaşılamayan bir bağlantı.
PrivacyLevel	Bağlantının gizlilik düzeyi ayarı. Zaman içinde ek gizlilik düzeyleri eklenebilir.
ServicePrincipalCredentials	ServicePrincipal CredentialType kimlik bilgileri.
ShareableCloudConnection	Bulut üzerinden bağlanan bir bağlantı.
SharedAccessSignatureCredentials	SharedAccessSignature CredentialType kimlik bilgileri.
SingleSignOnType	Bağlantının çoklu oturum açma türü. Zaman içinde ek çoklu oturum açma türleri eklenebilir.
VirtualNetworkGatewayConnection	Sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantı.
WindowsCredentials	Windows CredentialType için kimlik bilgileri.
WindowsWithoutImpersonationCredentials	WindowsWithoutImpersonation CredentialType kimlik bilgileri.
WorkspaceIdentityCredentials	WorkspaceIdentity CredentialType kimlik bilgileri.

AnonymousCredentials

Nesne

Anonim CredentialType için kimlik bilgileri.

Name	Tür	Description
credentialType	string: Anonymous	Bağlantının kimlik bilgisi türü.

BasicCredentials

Nesne

Temel CredentialType için kimlik bilgileri.

Name	Tür	Description
credentialType	string: Basic	Bağlantının kimlik bilgisi türü.
password	string	Parola. Password veya passwordReference kullanın. Her ikisini aynı anda kullanamazsınız
passwordReference	KeyVaultSecretReference	Azure Key Vault'ta depolanan parola başvurusu. Password veya passwordReference kullanın. İkisini de aynı anda kullanamazsınız.
username	string	Kullanıcı adı.

ConnectionDetailsBooleanParameter

Nesne

Boole dataType için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: Boolean	Parametresinin veri türü.
name	string	Parametresinin adı.
value	boolean	Boole değeri.

ConnectionDetailsDateParameter

Nesne

Date dataType için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: Date	Parametresinin veri türü.
name	string	Parametresinin adı.
value	string (date)	YYYY-MM-DD biçimini kullanan tarih değeri.

ConnectionDetailsDateTimeParameter

Nesne

dateTime dataType için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: DateTime	Parametresinin veri türü.
name	string	Parametresinin adı.
value	string (date-time)	YYYY-AA-GGTHH:dd:ss kullanılarak tarih saat değeri. FFFZ biçimi.

ConnectionDetailsDateTimeZoneParameter

Nesne

dateTimeZone dataType için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: DateTimeZone	Parametresinin veri türü.
name	string	Parametresinin adı.
value	string (date-time-offset)	YYYY-AA-GGTHH:dd:ss kullanan tarih saat dilimi değeri. FFF±hh:mm biçimi.

ConnectionDetailsDurationParameter

Nesne

DataType süresi için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: Duration	Parametresinin veri türü.
name	string	Parametresinin adı.
value	string (time-span)	[-]P(n)DT(n)H(n)M(n)S biçimini kullanan süre değeri. Örneğin: P3DT4H30M10S (3 gün, 4 saat, 30 dakika ve 10 saniye için).

ConnectionDetailsNumberParameter

Nesne

dataType sayısı için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: Number	Parametresinin veri türü.
name	string	Parametresinin adı.
value	number	Sayı değeri.

ConnectionDetailsTextParameter

Nesne

dataType metni için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: Text	Parametresinin veri türü.
name	string	Parametresinin adı.
value	string	Metin değeri.

ConnectionDetailsTimeParameter

Nesne

Time dataType için ConnectionDetailsParameter.

Name	Tür	Description
dataType	string: Time	Parametresinin veri türü.
name	string	Parametresinin adı.
value	string (time)	HH:mm:ss kullanan zaman değeri. FFFZ biçimi.

ConnectionEncryption

Numaralandırma

Bağlantının bağlantı şifreleme türü. Zaman içinde ek bağlantı şifreleme değerleri eklenebilir.

Değer	Description
Encrypted	Bağlantı girişimi şifreli bir bağlantı kullanılarak yapılır.
Any	Bağlantı girişimi önce şifreli bir bağlantı kullanılarak yapılır, ardından başarısız olursa şifrelenmemiş bağlantıya geri döner.
NotEncrypted	Bağlantı girişimi şifrelenmemiş bir bağlantı kullanılarak yapılır.

ConnectivityType

Numaralandırma

Bağlantının bağlantı türü. Zaman içinde ek bağlantı türleri eklenebilir.

Değer	Description
ShareableCloud	Bağlantı bulut üzerinden bağlanır ve başkalarıyla paylaşılabilir.
PersonalCloud	Bağlantı bulut üzerinden bağlanır ve başkalarıyla paylaşılamaz.
OnPremisesGateway	Bağlantı, şirket içi veri ağ geçidi üzerinden bağlanır.
OnPremisesGatewayPersonal	Bağlantı, kişisel bir şirket içi veri ağ geçidi üzerinden bağlanır.
VirtualNetworkGateway	Bağlantı bir sanal ağ veri ağ geçidi üzerinden bağlanır.
Automatic	Bağlantı, örtük bir veri bağlantısı kullanarak bulut üzerinden bağlanır. Bu seçenek yalnızca Tek Sign-On (SSO) kullanan anlamsal modeller gibi belirli senaryolarda kullanılabilir."
None	Bağlantı bağlı değil

CreateCloudConnectionRequest

Nesne

Name	Tür	Default value	Description
allowConnectionUsageInGateway	boolean		Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.
allowUsageInUserControlledCode	boolean	False	Bu bağlantının Not Defteri gibi kullanıcı tarafından denetlenen koda izin veren öğelerle kullanılmasına izin ver
connectionDetails	CreateConnectionDetails		Bağlantının bağlantı ayrıntıları.
connectivityType	string: ShareableCloud		Bağlantının bağlantı türü.
credentialDetails	CreateCredentialDetails		Bağlantının kimlik bilgileri.
displayName	string		Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.
privacyLevel	PrivacyLevel		(İsteğe bağlı) Bağlantının gizlilik düzeyi. Hiçbir değer geçirilmiyorsa, bu 'Kuruluş' olarak ayarlanır.

CreateConnectionDetails

Nesne

Bağlantı, oluşturma işlemleri için girişi ayrıntılarıyla açıklar.

Name	Tür	Description
creationMethod	string	Bağlantıyı oluşturmak için kullanılan oluşturma yöntemi. Oluşturma yöntemlerinin listesi için ListSupportedConnectionTypes API'sini kullanın.
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Bağlantı parametrelerinin listesi. Her oluşturma yöntemi için parametrelerin listesi için ListSupportedConnectionTypes API'sini kullanın.
type	string	Bağlantının türü.

CreateCredentialDetails

Nesne

Kimlik bilgisi, bağlantı oluşturmak için giriş bilgilerini gösterir.

Name	Tür	Description
connectionEncryption	ConnectionEncryption	(İsteğe bağlı) Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı. Hiçbir değer geçirilmediğinde, bağlantı şifrelenmez.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Bağlantının kimlik bilgileri.
singleSignOnType	SingleSignOnType	(İsteğe bağlı) Bağlantının çoklu oturum açma türü. Hiçbir değer geçirilmiyorsa, bağlantı çoklu oturum açma kullanmaz.
skipTestConnection	boolean	Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın. Hiçbir değer geçirilmiyorsa, bu 'False' olarak ayarlanır.

CreateOnPremisesConnectionRequest

Nesne

Name	Tür	Description
connectionDetails	CreateConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: OnPremisesGateway	Bağlantının bağlantı türü.
credentialDetails	CreateOnPremisesCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.
gatewayId	string (uuid)	Bağlantının oluşturulduğu şirket içi ağ geçidinin birincil ağ geçidinin nesne kimliği.
privacyLevel	PrivacyLevel	(İsteğe bağlı) Bağlantının gizlilik düzeyi. Hiçbir değer geçirilmiyorsa, bu 'Kuruluş' olarak ayarlanır.

CreateOnPremisesCredentialDetails

Nesne

Şirket içi ağ geçidi bağlantısı oluşturmaya yönelik kimlik bilgisi ayrıntıları girişi.

Name	Tür	Description
connectionEncryption	ConnectionEncryption	(İsteğe bağlı) Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı. Hiçbir değer geçirilmediğinde, bağlantı şifrelenmez.
credentials	OnPremisesGatewayCredentials	Bağlantının kimlik bilgileri.
singleSignOnType	SingleSignOnType	(İsteğe bağlı) Bağlantının çoklu oturum açma türü. Hiçbir değer geçirilmiyorsa, bağlantı çoklu oturum açma kullanmaz.
skipTestConnection	boolean	Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın. Hiçbir değer geçirilmiyorsa, bu 'False' olarak ayarlanır.

CreateVirtualNetworkGatewayConnectionRequest

Nesne

Name	Tür	Description
connectionDetails	CreateConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: VirtualNetworkGateway	Bağlantının bağlantı türü.
credentialDetails	CreateCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.
gatewayId	string (uuid)	Bağlantının altında oluşturulduğu sanal ağ geçidinin nesne kimliği.
privacyLevel	PrivacyLevel	(İsteğe bağlı) Bağlantının gizlilik düzeyi. Hiçbir değer geçirilmiyorsa, bu 'Kuruluş' olarak ayarlanır.

CredentialType

Numaralandırma

Bağlantının kimlik bilgisi türü. Zaman içinde ek kimlik bilgisi türleri eklenebilir.

Değer	Description
Windows	Bağlantı, bağlanmak için Windows kimlik doğrulamasını kullanır. Yalnızca şirket içi ağ geçitleri için desteklenir.
Anonymous	Bağlantı, bağlanmak için anonim kimlik doğrulaması kullanır.
Basic	Bağlantı, bağlanmak için temel kimlik doğrulamasını kullanır.
Key	Bağlantı, bağlanmak için anahtar kimlik doğrulamasını kullanır.
OAuth2	Bağlantı, bağlanmak için OAuth 2.0 kimlik doğrulamasını kullanır.
WindowsWithoutImpersonation	Bağlantı, bağlanmak için Windows (kimliğe bürünme seçeneği olmadan) kimlik doğrulamasını kullanır. Yalnızca şirket içi ağ geçitleri (kişisel mod) için desteklenir.
SharedAccessSignature	Bağlantı, bağlanmak için paylaşılan erişim imzası (SAS) kimlik doğrulamasını kullanır.
ServicePrincipal	Bağlantı, bağlanmak için hizmet sorumlusu kimlik doğrulamasını kullanır.
WorkspaceIdentity	Bağlantı, bağlanmak için çalışma alanı kimliği kimlik doğrulamasını kullanır.
KeyPair	Bağlantı, bağlanmak için anahtar çifti kimlik doğrulamasını kullanır.

DataType

Numaralandırma

Bağlantı oluşturma parametre değerinin veri türü. Zaman içinde ek veri türü değerleri eklenebilir.

Değer	Description
Text	Parametre giriş değeri olarak metin kullanın.
Number	Sayıyı parametre giriş değeri (tamsayı veya kayan nokta) olarak kullanın.
Boolean	Parametre giriş değeri olarak boole değerini kullanın. False - değer false, True, değer true şeklindedir.
Duration	[-]P(n)DT(n)H(n)M(n)S biçimini kullanarak parametre giriş değeri olarak süre kullanın. Örneğin: P3DT4H30M10S (3 gün, 4 saat, 30 dakika ve 10 saniye için).
Date	YYYY-MM-DD biçimini kullanarak parametre giriş değeri olarak date kullanın.
DateTime	YYYY-AA-GGTHH:dd:ss kullanarak parametre giriş değeri olarak tarih saatini kullanın. FFFZ biçimi.
DateTimeZone	YYYY-AA-GGTHH:dd:ss kullanarak parametre giriş değeri olarak tarih saat dilimini kullanın. FFF±hh:mm biçimi.
Time	HH:mm:ss kullanarak parametre giriş değeri olarak zamanı kullanın. FFFZ biçimi.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

KeyCredentials

Nesne

Key CredentialType için kimlik bilgileri.

Name	Tür	Description
credentialType	string: Key	Bağlantının kimlik bilgisi türü.
key	string	Anahtar. key veya keyReference kullanın. İkisini de aynı anda kullanamazsınız.
keyReference	KeyVaultSecretReference	Azure Key Vault'ta depolanan bir anahtara başvuru. key veya keyReference kullanın. İkisini de aynı anda kullanamazsınız.

KeyPairCredentials

Nesne

KeyPair CredentialType için kimlik bilgileri.

Name	Tür	Description
credentialType	string: KeyPair	Bağlantının kimlik bilgisi türü.
identifier	string	Anahtarın tanımlayıcısı.
passphrase	string	Özel anahtar şifrelenirse özel anahtarın parolası.
privateKey	string	PKCS #8 standardını temel alan özel anahtar.

KeyVaultSecretReference

Nesne

Azure Key Vault'ta depolanan bir gizli diziye başvuru.

Name	Tür	Description
connectionId	string (uuid)	Key Vault bağlantısının bağlantı kimliği.
secretName	string	Key Vault'taki gizli dizinin adı.
version	string	Key Vault'taki gizli dizi sürümü.

ListConnectionDetails

Nesne

Liste işlemleri için bağlantı ayrıntıları çıktısı.

Name	Tür	Description
path	string	Bağlantının yolu.
type	string	Bağlantının türü.

ListCredentialDetails

Nesne

Bağlantı getirilirken döndürülen kimlik bilgisi ayrıntıları.

Name	Tür	Description
connectionEncryption	ConnectionEncryption	Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı.
credentialType	CredentialType	Bağlantının kimlik bilgisi türü.
singleSignOnType	SingleSignOnType	Bağlantının çoklu oturum açma türü.
skipTestConnection	boolean	Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın.

OnPremisesCredentialEntry

Nesne

Ağ geçidi kimliği ve şifrelenmiş serileştirilmiş kimlik bilgileri.

Name	Tür	Description
encryptedCredentials	string	Ad değer çiftleri listesinin şifrelenmiş serileştirilmiş .json. Ad bir kimlik bilgisi adı ve değer bir kimlik bilgisi değeridir. Şifreleme, şirket içi ağ geçidi üyesinin ortak anahtarıyla Rivest-Shamir-Adleman (RSA) şifreleme algoritması kullanılarak gerçekleştirilir.
gatewayId	string (uuid)	Ağ geçidinin nesne kimliği.

OnPremisesGatewayConnection

Nesne

Şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.

Name	Tür	Description
connectionDetails	ListConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: OnPremisesGateway	Bağlantının bağlantı türü.
credentialDetails	ListCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı.
gatewayId	string (uuid)	Bağlantının ağ geçidi nesne kimliği.
id	string (uuid)	Bağlantının nesne kimliği.
privacyLevel	PrivacyLevel	Bağlantının gizlilik düzeyi.

OnPremisesGatewayCredentials

Nesne

Şirket içi ağ geçidinde kimlik doğrulaması için kimlik bilgileri.

Name	Tür	Description
credentialType	CredentialType	Bağlantının kimlik bilgisi türü.
values	OnPremisesCredentialEntry[]	Şirket içi ağ geçidine gönderilecek kimlik bilgisi yükü.

OnPremisesGatewayPersonalConnection

Nesne

Kişisel şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.

Name	Tür	Description
connectionDetails	ListConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: OnPremisesGatewayPersonal	Bağlantının bağlantı türü.
credentialDetails	ListCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı.
gatewayId	string (uuid)	Bağlantının ağ geçidi nesne kimliği.
id	string (uuid)	Bağlantının nesne kimliği.
privacyLevel	PrivacyLevel	Bağlantının gizlilik düzeyi.

PersonalCloudConnection

Nesne

Bulut üzerinden bağlanan ve paylaşılamayan bir bağlantı.

Name	Tür	Description
allowConnectionUsageInGateway	boolean	Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.
connectionDetails	ListConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: PersonalCloud	Bağlantının bağlantı türü.
credentialDetails	ListCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı.
id	string (uuid)	Bağlantının nesne kimliği.
privacyLevel	PrivacyLevel	Bağlantının gizlilik düzeyi.

PrivacyLevel

Numaralandırma

Bağlantının gizlilik düzeyi ayarı. Zaman içinde ek gizlilik düzeyleri eklenebilir.

Değer	Description
None	Hiçbir gizlilik düzeyi ayarı yapılandırılmadı.
Private	Özel olarak ayarlanan bağlantılar hassas veya gizli bilgiler içerir. Görünürlük yetkili kullanıcılarla sınırlandırılabilir. Özel bağlantıdaki veriler, diğer özel bağlantılar da dahil olmak üzere diğer bağlantılara katlanamaz.
Organizational	Kuruluşa ayarlanan bağlantılar, özel ve diğer kuruluş bağlantılarına katlanabilir. Ortak bağlantılara katlayamazlar. Görünürlük güvenilir bir gruba ayarlanır.
Public	Dosyalar, internet bağlantıları ve çalışma kitabı verileri genel olarak ayarlanabilir. Veriler diğer bağlantılara katlanabilir. Görünürlük herkes tarafından kullanılabilir.

ServicePrincipalCredentials

Nesne

ServicePrincipal CredentialType kimlik bilgileri.

Name	Tür	Description
credentialType	string: ServicePrincipal	Bağlantının kimlik bilgisi türü.
servicePrincipalClientId	string (uuid)	Hizmet sorumlusunun istemci kimliği.
servicePrincipalSecret	string	Hizmet sorumlusunun gizli dizisi. servicePrincipalSecret veya servicePrincipalSecretReference kullanın. İkisini de aynı anda kullanamazsınız.
servicePrincipalSecretReference	KeyVaultSecretReference	Azure Key Vault'ta depolanan bir hizmet sorumlusu gizli dizisine başvuru. servicePrincipalSecret veya servicePrincipalSecretReference kullanın. İkisini de aynı anda kullanamazsınız.
tenantId	string (uuid)	Hizmet sorumlusunun kiracı kimliği.

ShareableCloudConnection

Nesne

Bulut üzerinden bağlanan bir bağlantı.

Name	Tür	Description
allowConnectionUsageInGateway	boolean	Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.
allowUsageInUserControlledCode	boolean	Bu bağlantının Not Defteri gibi kullanıcı tarafından denetlenen koda izin veren öğelerle kullanılmasına izin verin.
connectionDetails	ListConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: ShareableCloud	Bağlantının bağlantı türü.
credentialDetails	ListCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı.
id	string (uuid)	Bağlantının nesne kimliği.
privacyLevel	PrivacyLevel	Bağlantının gizlilik düzeyi.

SharedAccessSignatureCredentials

Nesne

SharedAccessSignature CredentialType kimlik bilgileri.

Name	Tür	Description
credentialType	string: SharedAccessSignature	Bağlantının kimlik bilgisi türü.
token	string	Belirteç. Token veya tokenReference kullanın. İkisini de aynı anda kullanamazsınız.
tokenReference	KeyVaultSecretReference	Azure Key Vault'ta depolanan bir belirtecin başvurusu. Token veya tokenReference kullanın. İkisini de aynı anda kullanamazsınız.

SingleSignOnType

Numaralandırma

Bağlantının çoklu oturum açma türü. Zaman içinde ek çoklu oturum açma türleri eklenebilir.

Değer	Description
None	Bağlantı, bağlanmak için çoklu oturum açma kullanmaz.
Kerberos	Bağlantı, bağlanmak için Kerberos çoklu oturum açma kullanır.
MicrosoftEntraID	Bağlantı, bağlanmak için Microsoft Entra ID çoklu oturum açmayı kullanır.
SecurityAssertionMarkupLanguage	Bağlantı, bağlanmak için Güvenlik Onaylama İşaretleme Dili (SAML) çoklu oturum açma kullanır.
KerberosDirectQueryAndRefresh	Bağlantı, bağlanmak için Kerberos DirectQuery ve Refresh çoklu oturum açmayı kullanır.

VirtualNetworkGatewayConnection

Nesne

Sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantı.

Name	Tür	Description
connectionDetails	ListConnectionDetails	Bağlantının bağlantı ayrıntıları.
connectivityType	string: VirtualNetworkGateway	Bağlantının bağlantı türü.
credentialDetails	ListCredentialDetails	Bağlantının kimlik bilgileri.
displayName	string	Bağlantının görünen adı.
gatewayId	string (uuid)	Bağlantının ağ geçidi nesne kimliği.
id	string (uuid)	Bağlantının nesne kimliği.
privacyLevel	PrivacyLevel	Bağlantının gizlilik düzeyi.

WindowsCredentials

Nesne

Windows CredentialType için kimlik bilgileri.

Name	Tür	Description
credentialType	string: Windows	Bağlantının kimlik bilgisi türü.
password	string	Parola.
username	string	Kullanıcı adı.

WindowsWithoutImpersonationCredentials

Nesne

WindowsWithoutImpersonation CredentialType kimlik bilgileri.

Name	Tür	Description
credentialType	string: WindowsWithoutImpersonation	Bağlantının kimlik bilgisi türü.

WorkspaceIdentityCredentials

Nesne

WorkspaceIdentity CredentialType kimlik bilgileri.

Name	Tür	Description
credentialType	string: WorkspaceIdentity	Bağlantının kimlik bilgisi türü.