Connections - List Connections

Služba:: Core

Verze rozhraní API:: v1

Vrátí seznam místních, virtuálních a cloudových připojení, pro která má uživatel oprávnění.

Permissions

Volající musí mít oprávnění pro připojení.

Požadované delegovaná rozsahy

Connection.Read.All nebo 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

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
continuationToken	query		string	Token pro načtení další stránky výsledků.

Odpovědi

Name	Typ	Description
200 OK	ListConnectionsResponse	OK. Operace byla úspěšná.
Other Status Codes	ErrorResponse	Běžné kódy chyb: Neznámá chyba – došlo k chybě.

Name

Typ

Description

200 OK

ListConnectionsResponse

OK. Operace byla úspěšná.

Other Status Codes

ErrorResponse

Běžné kódy chyb:

Neznámá chyba – došlo k chybě.

Příklady

Example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
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í.
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ů.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ListConnectionDetails	Výstup podrobností o připojení pro operace seznamu.
ListConnectionsResponse
ListCredentialDetails	Podrobnosti přihlašovacích údajů vrácené při načítání připojení.
OnPremisesGatewayConnection	Připojení, které se připojuje přes místní bránu dat.
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ů.
ShareableCloudConnection	Připojení, které se připojuje přes cloud.
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ě.

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é.

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.

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

ListConnectionDetails

Objekt

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

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

ListConnectionsResponse

Objekt

Name	Typ	Description
continuationToken	string	Token pro další dávku sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
continuationUri	string	Identifikátor URI další dávky sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
value	Connection[]: OnPremisesGatewayConnection[] OnPremisesGatewayPersonalConnection[] PersonalCloudConnection[] ShareableCloudConnection[] VirtualNetworkGatewayConnection[]	Seznam vrácených 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í.

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í.

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.

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í.

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í.

Sdílet prostřednictvím

Connections - List Connections

Permissions

Požadované delegovaná rozsahy

Podporované identity Microsoft Entra

Interface

Parametry identifikátoru URI

Odpovědi

Příklady

Example

Ukázkový požadavek

Ukázková odpověď

Definice

ConnectionEncryption

ConnectivityType

CredentialType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ListConnectionDetails

ListConnectionsResponse

ListCredentialDetails

OnPremisesGatewayConnection

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ShareableCloudConnection

SingleSignOnType

VirtualNetworkGatewayConnection