Connections - Create Connection

Služba:: Core

Verze rozhraní API:: v1

Vytvoří připojení.
Informace o šifrování přihlašovacích údajů najdete v tématu Konfigurace přihlašovacích údajů prostřednictvím kódu programu.

Permissions

Pokud vytváříte připojení brány, volající musí mít pro bránu oprávnění.
Instanční objekty musí mít oprávnění udělená správcem infrastruktury. Další informace najdete v tématu: Instanční objekty můžou vytvářet pracovní prostory, připojení a kanály nasazení.

Požadované delegovaná rozsahy

Connection.ReadWrite.All

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identity	Support
User	Yes
instančního objektu a spravované identity	Yes

Interface

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

Text požadavku

Text žádosti může tvořit:

Name	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name	Vyžadováno	Typ	Description
connectionDetails	True	CreateConnectionDetails	Podrobnosti o připojení
connectivityType	True	string: ShareableCloud	Typ připojení připojení.
credentialDetails	True	CreateCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	True	string	Zobrazovaný název připojení. Maximální délka je 200 znaků.
allowConnectionUsageInGateway		boolean	Povolte použití tohoto připojení s místními bránami dat nebo branami dat virtuální sítě.
privacyLevel		PrivacyLevel	(Volitelné) Úroveň ochrany osobních údajů připojení. Pokud se nepředá žádná hodnota, nastaví se na Organizační.

CreateOnPremisesConnectionRequest

Name	Vyžadováno	Typ	Description
connectionDetails	True	CreateConnectionDetails	Podrobnosti o připojení
connectivityType	True	string: OnPremisesGateway	Typ připojení připojení.
credentialDetails	True	CreateOnPremisesCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	True	string	Zobrazovaný název připojení. Maximální délka je 200 znaků.
gatewayId	True	string (uuid)	ID objektu primární brány místní brány, pod kterou je připojení vytvořeno.
privacyLevel		PrivacyLevel	(Volitelné) Úroveň ochrany osobních údajů připojení. Pokud se nepředá žádná hodnota, nastaví se na Organizační.

CreateVirtualNetworkGatewayConnectionRequest

Name	Vyžadováno	Typ	Description
connectionDetails	True	CreateConnectionDetails	Podrobnosti o připojení
connectivityType	True	string: VirtualNetworkGateway	Typ připojení připojení.
credentialDetails	True	CreateCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	True	string	Zobrazovaný název připojení. Maximální délka je 200 znaků.
gatewayId	True	string (uuid)	ID objektu brány virtuální sítě, ve které je připojení vytvořeno.
privacyLevel		PrivacyLevel	(Volitelné) Úroveň ochrany osobních údajů připojení. Pokud se nepředá žádná hodnota, nastaví se na Organizační.

Odpovědi

Name	Typ	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Operace byla úspěšná.
Other Status Codes	ErrorResponse	Běžné kódy chyb: DuplicateConnectionName – název připojení se už používá. InvalidConnectionDetails – Zadaný vstup ConnectionDetails není platný. InvalidCredentialDetails – Zadaný vstup CredentialDetails není platný. IncorrectCredentials – Nepodařilo se navázat připojení pomocí vstupu Přihlašovací údaje. CreateGatewayConnectionFailed – Nepodařilo se vytvořit připojení brány.

Name

Typ

Description

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. Operace byla úspěšná.

Other Status Codes

ErrorResponse

Běžné kódy chyb:

DuplicateConnectionName – název připojení se už používá.
InvalidConnectionDetails – Zadaný vstup ConnectionDetails není platný.
InvalidCredentialDetails – Zadaný vstup CredentialDetails není platný.
IncorrectCredentials – Nepodařilo se navázat připojení pomocí vstupu Přihlašovací údaje.
CreateGatewayConnectionFailed – Nepodařilo se vytvořit připojení brány.

Příklady

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Name	Description
AnonymousCredentials	Přihlašovací údaje pro anonymní typ přihlašovacích údajů
BasicCredentials	Přihlašovací údaje pro základní credentialType
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter pro boolean dataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter pro datový typ data.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter for dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter pro dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter for duration dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter pro číselný datový typ
ConnectionDetailsTextParameter	ConnectionDetailsParameter for text dataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter for time dataType.
ConnectionEncryption	Typ šifrování připojení. V průběhu času se můžou přidat další hodnoty šifrování připojení.
ConnectivityType	Typ připojení připojení. V průběhu času se můžou přidat další typy připojení.
CreateCloudConnectionRequest
CreateConnectionDetails	Vstup podrobností o připojení pro operace vytvoření.
CreateCredentialDetails	Zadání podrobností přihlašovacích údajů pro vytvoření připojení.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Zadání podrobností přihlašovacích údajů pro vytvoření připojení místní brány.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Typ přihlašovacích údajů připojení. V průběhu času je možné přidat další typy přihlašovacích údajů.
DataType	Datový typ hodnoty parametru vytvoření připojení. Další hodnoty datového typu mohou být v průběhu času přidány.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
KeyCredentials	Přihlašovací údaje pro klíč CredentialType.
ListConnectionDetails	Výstup podrobností o připojení pro operace seznamu.
ListCredentialDetails	Podrobnosti přihlašovacích údajů vrácené při načítání připojení.
OnPremisesCredentialEntry	ID brány a jeho šifrované serializované přihlašovací údaje.
OnPremisesGatewayConnection	Připojení, které se připojuje přes místní bránu dat.
OnPremisesGatewayCredentials	Přihlašovací údaje pro ověřování prostřednictvím místní brány
OnPremisesGatewayPersonalConnection	Připojení, které se připojuje prostřednictvím osobní místní brány dat.
PersonalCloudConnection	Připojení, které se připojuje přes cloud a nelze ho sdílet.
PrivacyLevel	Nastavení úrovně ochrany osobních údajů připojení. V průběhu času je možné přidat další úrovně ochrany osobních údajů.
ServicePrincipalCredentials	Přihlašovací údaje pro servicePrincipal CredentialType.
ShareableCloudConnection	Připojení, které se připojuje přes cloud.
SharedAccessSignatureCredentials	Přihlašovací údaje pro SharedAccessSignature CredentialType.
SingleSignOnType	Typ jednotného přihlašování připojení. V průběhu času je možné přidat další typy jednotného přihlašování.
VirtualNetworkGatewayConnection	Připojení, které se připojuje přes bránu dat virtuální sítě.
WindowsCredentials	Přihlašovací údaje pro Windows CredentialType.
WindowsWithoutImpersonationCredentials	Přihlašovací údaje pro WindowsWithoutImpersonation CredentialType
WorkspaceIdentityCredentials	Přihlašovací údaje pro credentialType služby WorkspaceIdentity.

AnonymousCredentials

Objekt

Přihlašovací údaje pro anonymní typ přihlašovacích údajů

Name	Typ	Description
credentialType	string: Anonymous	Typ přihlašovacích údajů připojení.

BasicCredentials

Objekt

Přihlašovací údaje pro základní credentialType

Name	Typ	Description
credentialType	string: Basic	Typ přihlašovacích údajů připojení.
password	string	Heslo.
username	string	Uživatelské jméno.

ConnectionDetailsBooleanParameter

Objekt

ConnectionDetailsParameter pro boolean dataType.

Name	Typ	Description
dataType	string: Boolean	Datový typ parametru.
name	string	Název parametru.
value	boolean	Logická hodnota.

ConnectionDetailsDateParameter

Objekt

ConnectionDetailsParameter pro datový typ data.

Name	Typ	Description
dataType	string: Date	Datový typ parametru.
name	string	Název parametru.
value	string (date)	Hodnota data pomocí formátu RRRR-MM-DD.

ConnectionDetailsDateTimeParameter

Objekt

ConnectionDetailsParameter for dateTime dataType.

Name	Typ	Description
dataType	string: DateTime	Datový typ parametru.
name	string	Název parametru.
value	string (date-time)	Hodnota data a času pomocí YYYYY-MM-DDTHH:mm:ss. Formát FFFZ.

ConnectionDetailsDateTimeZoneParameter

Objekt

ConnectionDetailsParameter pro dateTimeZone dataType.

Name	Typ	Description
dataType	string: DateTimeZone	Datový typ parametru.
name	string	Název parametru.
value	string (date-time-offset)	Hodnota časového pásma data pomocí YYYY-MM-DDTHH:mm:ss. FFF±hh:mm.

ConnectionDetailsDurationParameter

Objekt

ConnectionDetailsParameter for duration dataType.

Name	Typ	Description
dataType	string: Duration	Datový typ parametru.
name	string	Název parametru.
value	string (time-span)	Hodnota doby trvání ve formátu {P(n)DT(n)H(n)M(n)S. Příklad: P3DT4H30M10S (3 dny, 4 hodiny, 30 minut a 10 sekund).

ConnectionDetailsNumberParameter

Objekt

ConnectionDetailsParameter pro číselný datový typ

Name	Typ	Description
dataType	string: Number	Datový typ parametru.
name	string	Název parametru.
value	number	Číselná hodnota.

ConnectionDetailsTextParameter

Objekt

ConnectionDetailsParameter for text dataType.

Name	Typ	Description
dataType	string: Text	Datový typ parametru.
name	string	Název parametru.
value	string	Textová hodnota.

ConnectionDetailsTimeParameter

Objekt

ConnectionDetailsParameter for time dataType.

Name	Typ	Description
dataType	string: Time	Datový typ parametru.
name	string	Název parametru.
value	string (time)	Hodnota času pomocí HH:mm:ss. Formát FFFZ.

ConnectionEncryption

Výčet

Typ šifrování připojení. V průběhu času se můžou přidat další hodnoty šifrování připojení.

Hodnota	Description
Encrypted	Pokus o připojení se provádí pomocí šifrovaného připojení.
Any	Pokus o připojení se nejprve provede pomocí šifrovaného připojení a v případě neúspěchu se vrátí zpět na nešifrované připojení.
NotEncrypted	Pokus o připojení se provádí pomocí nešifrovaného připojení.

ConnectivityType

Výčet

Typ připojení připojení. V průběhu času se můžou přidat další typy připojení.

Hodnota	Description
ShareableCloud	Připojení se připojuje přes cloud a je možné ho sdílet s ostatními.
PersonalCloud	Připojení se připojuje přes cloud a není možné ho sdílet s ostatními.
OnPremisesGateway	Připojení se připojuje přes místní bránu dat.
OnPremisesGatewayPersonal	Připojení se připojuje prostřednictvím osobní místní brány dat.
VirtualNetworkGateway	Připojení se připojuje přes bránu dat virtuální sítě.
Automatic	Připojení se připojuje přes cloud pomocí implicitního datového připojení. Tato možnost je dostupná jenom pro konkrétní scénáře, jako jsou sémantické modely, které používají jednotné Sign-On (SSO).
None	Připojení není vázané.

CreateCloudConnectionRequest

Objekt

Name	Typ	Description
allowConnectionUsageInGateway	boolean	Povolte použití tohoto připojení s místními bránami dat nebo branami dat virtuální sítě.
connectionDetails	CreateConnectionDetails	Podrobnosti o připojení
connectivityType	string: ShareableCloud	Typ připojení připojení.
credentialDetails	CreateCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení. Maximální délka je 200 znaků.
privacyLevel	PrivacyLevel	(Volitelné) Úroveň ochrany osobních údajů připojení. Pokud se nepředá žádná hodnota, nastaví se na Organizační.

CreateConnectionDetails

Objekt

Vstup podrobností o připojení pro operace vytvoření.

Name	Typ	Description
creationMethod	string	Metoda vytvoření použitá k vytvoření připojení. Seznam metod vytvoření použijte rozhraní API ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Seznam parametrů připojení. Seznam parametrů pro každou metodu vytvoření použijte rozhraní API ListSupportedConnectionTypes .
type	string	Typ připojení.

CreateCredentialDetails

Objekt

Zadání podrobností přihlašovacích údajů pro vytvoření připojení.

Name	Typ	Description
connectionEncryption	ConnectionEncryption	(Volitelné) Nastavení šifrování připojení, které se používá během testovacího připojení. Pokud není předána žádná hodnota, připojení není šifrované.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Přihlašovací údaje připojení.
singleSignOnType	SingleSignOnType	(Volitelné) Typ jednotného přihlašování připojení. Pokud se nepředá žádná hodnota, připojení nepoužívá jednotné přihlašování.
skipTestConnection	boolean	Určuje, jestli má připojení během vytváření a aktualizace přeskočit testovací připojení. True – přeskočte testovací připojení, Nepravda – Nepřekočujte testovací připojení. Pokud se nepředá žádná hodnota, nastaví se na False.

CreateOnPremisesConnectionRequest

Objekt

Name	Typ	Description
connectionDetails	CreateConnectionDetails	Podrobnosti o připojení
connectivityType	string: OnPremisesGateway	Typ připojení připojení.
credentialDetails	CreateOnPremisesCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení. Maximální délka je 200 znaků.
gatewayId	string (uuid)	ID objektu primární brány místní brány, pod kterou je připojení vytvořeno.
privacyLevel	PrivacyLevel	(Volitelné) Úroveň ochrany osobních údajů připojení. Pokud se nepředá žádná hodnota, nastaví se na Organizační.

CreateOnPremisesCredentialDetails

Objekt

Zadání podrobností přihlašovacích údajů pro vytvoření připojení místní brány.

Name	Typ	Description
connectionEncryption	ConnectionEncryption	(Volitelné) Nastavení šifrování připojení, které se používá během testovacího připojení. Pokud není předána žádná hodnota, připojení není šifrované.
credentials	OnPremisesGatewayCredentials	Přihlašovací údaje připojení.
singleSignOnType	SingleSignOnType	(Volitelné) Typ jednotného přihlašování připojení. Pokud se nepředá žádná hodnota, připojení nepoužívá jednotné přihlašování.
skipTestConnection	boolean	Určuje, jestli má připojení během vytváření a aktualizace přeskočit testovací připojení. True – přeskočte testovací připojení, Nepravda – Nepřekočujte testovací připojení. Pokud se nepředá žádná hodnota, nastaví se na False.

CreateVirtualNetworkGatewayConnectionRequest

Objekt

Name	Typ	Description
connectionDetails	CreateConnectionDetails	Podrobnosti o připojení
connectivityType	string: VirtualNetworkGateway	Typ připojení připojení.
credentialDetails	CreateCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení. Maximální délka je 200 znaků.
gatewayId	string (uuid)	ID objektu brány virtuální sítě, ve které je připojení vytvořeno.
privacyLevel	PrivacyLevel	(Volitelné) Úroveň ochrany osobních údajů připojení. Pokud se nepředá žádná hodnota, nastaví se na Organizační.

CredentialType

Výčet

Typ přihlašovacích údajů připojení. V průběhu času je možné přidat další typy přihlašovacích údajů.

Hodnota	Description
Windows	Připojení používá k připojení ověřování systému Windows. Podporuje se jenom pro místní brány.
Anonymous	Připojení používá k připojení anonymní ověřování.
Basic	Připojení používá k připojení základní ověřování.
Key	Připojení používá k připojení ověřování pomocí klíče.
OAuth2	Připojení k připojení používá ověřování OAuth 2.0.
WindowsWithoutImpersonation	Připojení používá k připojení windows (bez možnosti zosobnění). Podporuje se jenom pro místní brány (osobní režim).
SharedAccessSignature	Připojení používá pro připojení ověřování sdíleného přístupového podpisu (SAS).
ServicePrincipal	Připojení používá k připojení ověřování instančního objektu.
WorkspaceIdentity	Připojení používá k připojení ověřování identit pracovního prostoru.

DataType

Výčet

Datový typ hodnoty parametru vytvoření připojení. Další hodnoty datového typu mohou být v průběhu času přidány.

Hodnota	Description
Text	Jako vstupní hodnotu parametru použijte text.
Number	Použijte číslo jako vstupní hodnotu parametru (celé číslo nebo číslo s plovoucí desetinou čárkou).
Boolean	Jako vstupní hodnotu parametru použijte logickou hodnotu. False – hodnota je false, Pravda – hodnota je pravdivá.
Duration	Jako vstupní hodnotu parametru použijte dobu trvání pomocí formátu {P(n)DT(n)H(n)M(n)S. Příklad: P3DT4H30M10S (3 dny, 4 hodiny, 30 minut a 10 sekund).
Date	Datum použijte jako vstupní hodnotu parametru pomocí formátu RRRR-MM-DD.
DateTime	Jako vstupní hodnotu parametru použijte datum a použijte YYYY-MM-DDTHH:mm:ss. Formát FFFZ.
DateTimeZone	Jako vstupní hodnotu parametru použijte časové pásmo data pomocí YYYYY-MM-DDTHH:mm:ss. FFF±hh:mm.
Time	Použijte čas jako vstupní hodnotu parametru pomocí HH:mm:ss. Formát FFFZ.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

KeyCredentials

Objekt

Přihlašovací údaje pro klíč CredentialType.

Name	Typ	Description
credentialType	string: Key	Typ přihlašovacích údajů připojení.
key	string	Klíč.

ListConnectionDetails

Objekt

Výstup podrobností o připojení pro operace seznamu.

Name	Typ	Description
path	string	Cesta připojení.
type	string	Typ připojení.

ListCredentialDetails

Objekt

Podrobnosti přihlašovacích údajů vrácené při načítání připojení.

Name	Typ	Description
connectionEncryption	ConnectionEncryption	Nastavení šifrování připojení, které se používá během testovacího připojení.
credentialType	CredentialType	Typ přihlašovacích údajů připojení.
singleSignOnType	SingleSignOnType	Typ jednotného přihlašování připojení.
skipTestConnection	boolean	Určuje, jestli má připojení během vytváření a aktualizace přeskočit testovací připojení. True – přeskočte testovací připojení, Nepravda – Nepřekočujte testovací připojení.

OnPremisesCredentialEntry

Objekt

ID brány a jeho šifrované serializované přihlašovací údaje.

Name	Typ	Description
encryptedCredentials	string	Šifrovaný serializovaný .json seznamu párů hodnot názvů. Název je název přihlašovacích údajů a hodnota je hodnota přihlašovacích údajů. Šifrování se provádí pomocí šifrovacího algoritmu Rivest-Shamir-Adleman (RSA) s veřejným klíčem člena místní brány.
gatewayId	string (uuid)	ID objektu brány.

OnPremisesGatewayConnection

Objekt

Připojení, které se připojuje přes místní bránu dat.

Name	Typ	Description
connectionDetails	ListConnectionDetails	Podrobnosti o připojení
connectivityType	string: OnPremisesGateway	Typ připojení připojení.
credentialDetails	ListCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení.
gatewayId	string (uuid)	ID objektu brány připojení.
id	string (uuid)	ID objektu připojení.
privacyLevel	PrivacyLevel	Úroveň ochrany osobních údajů připojení.

OnPremisesGatewayCredentials

Objekt

Přihlašovací údaje pro ověřování prostřednictvím místní brány

Name	Typ	Description
credentialType	CredentialType	Typ přihlašovacích údajů připojení.
values	OnPremisesCredentialEntry[]	Datová část přihlašovacích údajů, která se má odeslat do místní brány.

OnPremisesGatewayPersonalConnection

Objekt

Připojení, které se připojuje prostřednictvím osobní místní brány dat.

Name	Typ	Description
connectionDetails	ListConnectionDetails	Podrobnosti o připojení
connectivityType	string: OnPremisesGatewayPersonal	Typ připojení připojení.
credentialDetails	ListCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení.
gatewayId	string (uuid)	ID objektu brány připojení.
id	string (uuid)	ID objektu připojení.
privacyLevel	PrivacyLevel	Úroveň ochrany osobních údajů připojení.

PersonalCloudConnection

Objekt

Připojení, které se připojuje přes cloud a nelze ho sdílet.

Name	Typ	Description
allowConnectionUsageInGateway	boolean	Povolte použití tohoto připojení s místními bránami dat nebo branami dat virtuální sítě.
connectionDetails	ListConnectionDetails	Podrobnosti o připojení
connectivityType	string: PersonalCloud	Typ připojení připojení.
credentialDetails	ListCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení.
id	string (uuid)	ID objektu připojení.
privacyLevel	PrivacyLevel	Úroveň ochrany osobních údajů připojení.

PrivacyLevel

Výčet

Nastavení úrovně ochrany osobních údajů připojení. V průběhu času je možné přidat další úrovně ochrany osobních údajů.

Hodnota	Description
None	Není nakonfigurováno žádné nastavení úrovně ochrany osobních údajů.
Private	Připojení nastavená na soukromé obsahují citlivé nebo důvěrné informace. Viditelnost může být omezena na oprávněné uživatele. Data z privátního připojení se nepřeloží na jiná připojení, včetně jiných privátních připojení.
Organizational	Připojení nastavená na organizaci se můžou skládat do privátních a dalších připojení organizace. Nemůžou se skládat do veřejných připojení. Viditelnost je nastavená na důvěryhodnou skupinu.
Public	Soubory, připojení k internetu a data sešitu lze nastavit na veřejné. Data se můžou skládat do jiných připojení. Viditelnost je dostupná všem uživatelům.

ServicePrincipalCredentials

Objekt

Přihlašovací údaje pro servicePrincipal CredentialType.

Name	Typ	Description
credentialType	string: ServicePrincipal	Typ přihlašovacích údajů připojení.
servicePrincipalClientId	string (uuid)	ID klienta instančního objektu.
servicePrincipalSecret	string	Tajný kód instančního objektu.
tenantId	string (uuid)	ID tenanta instančního objektu.

ShareableCloudConnection

Objekt

Připojení, které se připojuje přes cloud.

Name	Typ	Description
allowConnectionUsageInGateway	boolean	Povolte použití tohoto připojení s místními bránami dat nebo branami dat virtuální sítě.
connectionDetails	ListConnectionDetails	Podrobnosti o připojení
connectivityType	string: ShareableCloud	Typ připojení připojení.
credentialDetails	ListCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení.
id	string (uuid)	ID objektu připojení.
privacyLevel	PrivacyLevel	Úroveň ochrany osobních údajů připojení.

SharedAccessSignatureCredentials

Objekt

Přihlašovací údaje pro SharedAccessSignature CredentialType.

Name	Typ	Description
credentialType	string: SharedAccessSignature	Typ přihlašovacích údajů připojení.
token	string	Token.

SingleSignOnType

Výčet

Typ jednotného přihlašování připojení. V průběhu času je možné přidat další typy jednotného přihlašování.

Hodnota	Description
None	Připojení k připojení nepoužívá jednotné přihlašování.
Kerberos	Připojení používá pro připojení jednotné přihlašování kerberos.
MicrosoftEntraID	Připojení k připojení používá jednotné přihlašování Microsoft Entra ID.
SecurityAssertionMarkupLanguage	Připojení k připojení používá jednotné přihlašování SAML (Security Assertion Markup Language).
KerberosDirectQueryAndRefresh	Připojení používá k připojení Kerberos DirectQuery a obnovte jednotné přihlašování.

VirtualNetworkGatewayConnection

Objekt

Připojení, které se připojuje přes bránu dat virtuální sítě.

Name	Typ	Description
connectionDetails	ListConnectionDetails	Podrobnosti o připojení
connectivityType	string: VirtualNetworkGateway	Typ připojení připojení.
credentialDetails	ListCredentialDetails	Podrobnosti přihlašovacích údajů o připojení.
displayName	string	Zobrazovaný název připojení.
gatewayId	string (uuid)	ID objektu brány připojení.
id	string (uuid)	ID objektu připojení.
privacyLevel	PrivacyLevel	Úroveň ochrany osobních údajů připojení.

WindowsCredentials

Objekt

Přihlašovací údaje pro Windows CredentialType.

Name	Typ	Description
credentialType	string: Windows	Typ přihlašovacích údajů připojení.
password	string	Heslo.
username	string	Uživatelské jméno.

WindowsWithoutImpersonationCredentials

Objekt

Přihlašovací údaje pro WindowsWithoutImpersonation CredentialType

Name	Typ	Description
credentialType	string: WindowsWithoutImpersonation	Typ přihlašovacích údajů připojení.

WorkspaceIdentityCredentials

Objekt

Přihlašovací údaje pro credentialType služby WorkspaceIdentity.

Name	Typ	Description
credentialType	string: WorkspaceIdentity	Typ přihlašovacích údajů připojení.

Sdílet prostřednictvím

Connections - Create Connection

Permissions

Požadované delegovaná rozsahy

Podporované identity Microsoft Entra

Interface

Text požadavku

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Odpovědi

Příklady

Cloud example

Ukázkový požadavek

Ukázková odpověď

On-premises gateway example

Ukázkový požadavek

Ukázková odpověď

Virtual network gateway example

Ukázkový požadavek

Ukázková odpověď

Definice

AnonymousCredentials

BasicCredentials

ConnectionDetailsBooleanParameter

ConnectionDetailsDateParameter

ConnectionDetailsDateTimeParameter

ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsDurationParameter

ConnectionDetailsNumberParameter

ConnectionDetailsTextParameter

ConnectionDetailsTimeParameter

ConnectionEncryption

ConnectivityType

CreateCloudConnectionRequest

CreateConnectionDetails

CreateCredentialDetails

CreateOnPremisesConnectionRequest

CreateOnPremisesCredentialDetails

CreateVirtualNetworkGatewayConnectionRequest

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayConnection

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ServicePrincipalCredentials

ShareableCloudConnection

SharedAccessSignatureCredentials

SingleSignOnType

VirtualNetworkGatewayConnection

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials