Connections - Get Connection

Service:

Admin

Versione API:

v1

Restituisce la connessione specificata.

Note

Fabric gestione delle connessioni dell'amministratore tenant è attualmente disponibile in anteprima (altre informazioni).

Permissions

Il chiamante deve essere un amministratore di Fabric o eseguire l'autenticazione usando un'entità servizio.

Ambiti delegati obbligatori

Tenant.Read.All o Tenant.ReadWrite.All

Limitations

None.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interface

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
connectionId	path	True	string (uuid)	ID connessione.

Risposte

Nome	Tipo	Descrizione
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Operazione riuscita.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: EntityNotFound: impossibile trovare la risorsa richiesta.

Esempio

Get connection as admin example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/connections/f6a39b76-9816-4e4b-b93a-f42e405017b7

Risposta di esempio

Codice di stato:

200

{
  "id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
  "displayName": "ContosoConnection",
  "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": "NotEncrypted",
    "skipTestConnection": false
  }
}

Definizioni

Nome	Descrizione
ConnectionEncryption	Tipo di crittografia della connessione. È possibile aggiungere altri valori di crittografia della connessione nel tempo.
ConnectionRecency	Rappresenta i dettagli della recency sulla connessione.
ConnectionRole	Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.
ConnectivityType	Tipo di connettività della connessione. È possibile aggiungere altri tipi di connettività nel tempo.
CredentialType	Tipo di credenziale della connessione. È possibile aggiungere altri tipi di credenziali nel corso del tempo.
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ListConnectionDetails	Output dei dettagli della connessione per le operazioni di elenco.
ListCredentialDetails	I dettagli delle credenziali restituiti durante il recupero di una connessione.
OnPremisesGatewayConnection	Connessione che si connette tramite il gateway dati locale.
OnPremisesGatewayPersonalConnection	Connessione che si connette tramite un gateway dati locale personale.
PersonalCloudConnection	Connessione che si connette tramite il cloud e non può essere condivisa.
PrivacyLevel	Impostazione del livello di privacy della connessione. È possibile aggiungere livelli di privacy aggiuntivi nel tempo.
ShareableCloudConnection	Connessione che si connette attraverso il cloud.
SingleSignOnType	Tipo di accesso Single Sign-On della connessione. È possibile aggiungere altri tipi di accesso Single Sign-On nel tempo.
StreamingVirtualNetworkGatewayConnection	Connessione che si connette tramite un gateway dati di rete virtuale di streaming.
VirtualNetworkGatewayConnection	Connessione che si connette tramite un gateway dati di rete virtuale.

ConnectionEncryption

Enumerazione

Tipo di crittografia della connessione. È possibile aggiungere altri valori di crittografia della connessione nel tempo.

Valore	Descrizione
Encrypted	Il tentativo di connessione viene eseguito usando una connessione crittografata.
Any	Il tentativo di connessione viene prima eseguito usando una connessione crittografata, quindi esegue il fallback alla connessione non crittografata se non riesce.
NotEncrypted	Il tentativo di connessione viene eseguito usando una connessione non crittografata.

ConnectionRecency

Oggetto

Rappresenta i dettagli della recency sulla connessione.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Timestamp quando la connessione è stata creata in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Timestamp quando la connessione è stata associata più di recente a qualsiasi elemento in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Timestamp quando le credenziali di connessione sono state usate più di recente nell'ora UTC, usando il formato AAAA-MM-GGTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Timestamp quando la connessione è stata associata più di recente a qualsiasi elemento dall'utente chiamante in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Timestamp quando le credenziali di connessione sono state usate più di recente dall'utente chiamante in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.

ConnectionRole

Enumerazione

Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.

Valore	Descrizione
User	Abilita l'accesso utente per la connessione.
UserWithReshare	Abilita l'utente con accesso di ricondivisione per la connessione.
Owner	Abilita l'accesso alla proprietà per la connessione.
PendingOwner	La proprietà della connessione non è ancora effettiva; l'entità deve aggiornare le credenziali di connessione (usando l'API di connessione di aggiornamento) per renderla effettiva.

ConnectivityType

Enumerazione

Tipo di connettività della connessione. È possibile aggiungere altri tipi di connettività nel tempo.

Valore	Descrizione
ShareableCloud	La connessione si connette tramite il cloud e può essere condivisa con altri utenti.
PersonalCloud	La connessione si connette tramite il cloud e non può essere condivisa con altri utenti.
OnPremisesGateway	La connessione si connette tramite un gateway dati locale.
OnPremisesGatewayPersonal	La connessione si connette tramite un gateway dati locale personale.
VirtualNetworkGateway	La connessione si connette tramite un gateway dati di rete virtuale.
StreamingVirtualNetworkGateway	La connessione si connette tramite un gateway dati di rete virtuale di streaming.
Automatic	La connessione si connette tramite il cloud usando una connessione dati implicita. Questa opzione è disponibile solo per scenari specifici, ad esempio modelli semantici che usano Single Sign-On (SSO)."
None	La connessione non è associata

CredentialType

Enumerazione

Tipo di credenziale della connessione. È possibile aggiungere altri tipi di credenziali nel corso del tempo.

Valore	Descrizione
Windows	La connessione usa l'autenticazione di Windows per connettersi. Supportato solo per i gateway locali.
Anonymous	La connessione usa l'autenticazione anonima per connettersi.
Basic	La connessione usa l'autenticazione di base per connettersi.
Key	La connessione usa l'autenticazione della chiave per connettersi.
OAuth2	La connessione usa l'autenticazione OAuth 2.0 per connettersi.
WindowsWithoutImpersonation	La connessione usa Windows (senza l'opzione per la rappresentazione) per connettersi. Supportato solo per i gateway locali (modalità personale).
SharedAccessSignature	La connessione usa l'autenticazione di firma di accesso condiviso (SAS) per connettersi.
ServicePrincipal	La connessione usa l'autenticazione dell'entità servizio per connettersi.
WorkspaceIdentity	La connessione usa l'autenticazione dell'identità dell'area di lavoro per connettersi.
KeyPair	La connessione usa l'autenticazione della coppia di chiavi per connettersi.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

ListConnectionDetails

Oggetto

Output dei dettagli della connessione per le operazioni di elenco.

Nome	Tipo	Descrizione
path	string	Percorso della connessione.
type	string	Tipo di connessione.

ListCredentialDetails

Oggetto

I dettagli delle credenziali restituiti durante il recupero di una connessione.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	Impostazione di crittografia della connessione utilizzata durante la connessione di test.
credentialType	CredentialType	Tipo di credenziale della connessione.
singleSignOnType	SingleSignOnType	Tipo di accesso Single Sign-On della connessione.
skipTestConnection	boolean	Indica se la connessione deve ignorare la connessione di test durante la creazione e l'aggiornamento. True: ignorare la connessione di test, False: non ignorare la connessione di test.

OnPremisesGatewayConnection

Oggetto

Connessione che si connette tramite il gateway dati locale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: OnPremisesGateway	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

OnPremisesGatewayPersonalConnection

Oggetto

Connessione che si connette tramite un gateway dati locale personale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: OnPremisesGatewayPersonal	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

PersonalCloudConnection

Oggetto

Connessione che si connette tramite il cloud e non può essere condivisa.

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: PersonalCloud	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

PrivacyLevel

Enumerazione

Impostazione del livello di privacy della connessione. È possibile aggiungere livelli di privacy aggiuntivi nel tempo.

Valore	Descrizione
None	Non è configurata alcuna impostazione del livello di privacy.
Private	Le connessioni impostate su private contengono informazioni riservate o riservate. La visibilità può essere limitata agli utenti autorizzati. I dati di una connessione privata non verranno piegati ad altre connessioni, incluse altre connessioni private.
Organizational	Le connessioni impostate sull'organizzazione possono passare a connessioni private e ad altre connessioni organizzative. Non possono piegarsi alle connessioni pubbliche. La visibilità è impostata su un gruppo attendibile.
Public	I file, le connessioni Internet e i dati della cartella di lavoro possono essere impostati su pubblico. I dati possono essere piegati ad altre connessioni. La visibilità è disponibile per tutti.

ShareableCloudConnection

Oggetto

Connessione che si connette attraverso il cloud.

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
allowUsageInUserControlledCode	boolean	Consentire l'uso di questa connessione con elementi che consentono codice controllato dall'utente, ad esempio Notebook.
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: ShareableCloud	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

SingleSignOnType

Enumerazione

Tipo di accesso Single Sign-On della connessione. È possibile aggiungere altri tipi di accesso Single Sign-On nel tempo.

Valore	Descrizione
None	La connessione non usa l'accesso Single Sign-On per connettersi.
Kerberos	La connessione usa l'accesso Single Sign-On Kerberos per connettersi.
MicrosoftEntraID	La connessione usa l'accesso Single Sign-On di Microsoft Entra ID per connettersi.
SecurityAssertionMarkupLanguage	La connessione usa l'accesso Single Sign-On SAML (Security Assertion Markup Language) per la connessione.
KerberosDirectQueryAndRefresh	Per connettersi, la connessione usa Kerberos DirectQuery e Refresh.

StreamingVirtualNetworkGatewayConnection

Oggetto

Connessione che si connette tramite un gateway dati di rete virtuale di streaming.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: StreamingVirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway della connessione.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

VirtualNetworkGatewayConnection

Oggetto

Connessione che si connette tramite un gateway dati di rete virtuale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: VirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.