Connections - Get Connection

Tjeneste:: Admin

API-versjon:: v1

Returnerer den angitte tilkoblingen.

Note

Fabric administrasjon av leieradministratortilkobling er for øyeblikket i forhåndsvisning (finn ut mer).

Permissions

Innringeren må være en Fabric-administrator eller godkjenne ved hjelp av en tjenestekontohaver.

Nødvendige delegerte omfang

Tenant.Read.All eller Tenant.ReadWrite.All

Begrensninger

Ingen.

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identity	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Interface

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

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
connectionId	path	True	string (uuid)	Tilkoblings-ID-en.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Operasjonen var vellykket.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: EntityNotFound – Finner ikke den forespurte ressursen.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OK. Operasjonen var vellykket.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

EntityNotFound – Finner ikke den forespurte ressursen.

Eksempler

Get connection as admin example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:: 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
  }
}

Definisjoner

Name	Beskrivelse
ConnectionEncryption	Tilkoblingskrypteringstypen for tilkoblingen. Flere tilkoblingskrypteringsverdier kan legges til over tid.
ConnectionRecency	Representerer recency-detaljene om tilkoblingen.
ConnectionRole	En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.
ConnectivityType	Tilkoblingstypen for tilkoblingen. Flere tilkoblingstyper kan legges til over tid.
CredentialType	Legitimasjonstypen for tilkoblingen. Flere legitimasjonstyper kan legges til over tid.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ListConnectionDetails	Utdata for tilkoblingsdetaljer for listeoperasjoner.
ListCredentialDetails	Legitimasjonsdetaljene som returneres når du henter en tilkobling.
OnPremisesGatewayConnection	En tilkobling som kobles til via lokal datagateway.
OnPremisesGatewayPersonalConnection	En tilkobling som kobles til via en personlig lokal datagateway.
PersonalCloudConnection	En tilkobling som kobles til via skyen og ikke kan deles.
PrivacyLevel	Innstillingen for personvernnivå for tilkoblingen. Flere personvernnivåer kan legges til over tid.
ShareableCloudConnection	En tilkobling som kobles til via skyen.
SingleSignOnType	Enkel påloggingstype for tilkoblingen. Flere typer enkel pålogging kan legges til over tid.
StreamingVirtualNetworkGatewayConnection	En tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.
VirtualNetworkGatewayConnection	En tilkobling som kobles til via en virtuell nettverksdatagateway.

ConnectionEncryption

Opplisting

Tilkoblingskrypteringstypen for tilkoblingen. Flere tilkoblingskrypteringsverdier kan legges til over tid.

Verdi	Beskrivelse
Encrypted	Tilkoblingsforsøket utføres ved hjelp av en kryptert tilkobling.
Any	Tilkoblingsforsøket utføres først ved hjelp av en kryptert tilkobling, og faller deretter tilbake til ukryptert tilkobling hvis den ikke lykkes.
NotEncrypted	Tilkoblingsforsøket utføres ved hjelp av en ukryptert tilkobling.

ConnectionRecency

Objekt

Representerer recency-detaljene om tilkoblingen.

Name	Type	Beskrivelse
createdDateTime	string (date-time)	Tidsstempelet da tilkoblingen ble opprettet i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Tidsstempelet da tilkoblingen sist ble bundet til et element i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Tidsstempelet da tilkoblingslegitimasjonen sist ble brukt i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Tidsstempelet da tilkoblingen sist ble bundet til et element av anropsbrukeren i UTC, ved hjelp av YYYY-MM-DDTHH:mm:ssZ-formatet.
myLastCredentialUsedDateTime	string (date-time)	Tidsstempelet da tilkoblingslegitimasjonen sist ble brukt av anropsbrukeren i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.

ConnectionRole

Opplisting

En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.

Verdi	Beskrivelse
User	Aktiverer brukertilgang for tilkoblingen.
UserWithReshare	Aktiverer bruker med deling av tilgang på nytt for tilkoblingen.
Owner	Aktiverer eierskapstilgang for tilkoblingen.
PendingOwner	Eierskapet til tilkoblingen er ennå ikke effektivt. hovedstolen må oppdatere tilkoblingslegitimasjonen (ved hjelp av API for oppdateringstilkobling) for å gjøre den effektiv.

ConnectivityType

Opplisting

Tilkoblingstypen for tilkoblingen. Flere tilkoblingstyper kan legges til over tid.

Verdi	Beskrivelse
ShareableCloud	Tilkoblingen kobles til via skyen og kan deles med andre.
PersonalCloud	Tilkoblingen kobles til via skyen og kan ikke deles med andre.
OnPremisesGateway	Tilkoblingen kobles til via en lokal datagateway.
OnPremisesGatewayPersonal	Tilkoblingen kobles til via en personlig lokal datagateway.
VirtualNetworkGateway	Tilkoblingen kobles til via en virtuell nettverksdatagateway.
StreamingVirtualNetworkGateway	Tilkoblingen kobles til via en datagateway for strømming av virtuelle nettverk.
Automatic	Tilkoblingen kobles til via skyen ved hjelp av en implisitt datatilkobling. Dette alternativet er bare tilgjengelig for bestemte scenarioer som semantiske modeller som bruker enkel Sign-On (SSO)."
None	Tilkoblingen er ikke bundet

CredentialType

Opplisting

Legitimasjonstypen for tilkoblingen. Flere legitimasjonstyper kan legges til over tid.

Verdi	Beskrivelse
Windows	Tilkobling bruker Windows-godkjenning til å koble til. Støttes bare for lokale gatewayer.
Anonymous	Tilkobling bruker anonym godkjenning til å koble til.
Basic	Tilkobling bruker enkel godkjenning til å koble til.
Key	Tilkobling bruker nøkkelgodkjenning til å koble til.
OAuth2	Tilkobling bruker OAuth 2.0-godkjenning til å koble til.
WindowsWithoutImpersonation	Tilkobling bruker Windows -godkjenning (uten mulighet for representasjon) til å koble til. Støttes bare for lokale gatewayer (personlig modus).
SharedAccessSignature	Tilkobling bruker SAS-godkjenning (shared access signature) til å koble til.
ServicePrincipal	Tilkobling bruker tjenestekontohavergodkjenning til å koble til.
WorkspaceIdentity	Tilkobling bruker godkjenning av arbeidsområdeidentitet til å koble til.
KeyPair	Tilkobling bruker nøkkelpargodkjenning til å koble til.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ListConnectionDetails

Objekt

Utdata for tilkoblingsdetaljer for listeoperasjoner.

Name	Type	Beskrivelse
path	string	Banen til tilkoblingen.
type	string	Tilkoblingstypen.

ListCredentialDetails

Objekt

Legitimasjonsdetaljene som returneres når du henter en tilkobling.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen.
credentialType	CredentialType	Legitimasjonstypen for tilkoblingen.
singleSignOnType	SingleSignOnType	Enkel påloggingstype for tilkoblingen.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen.

OnPremisesGatewayConnection

Objekt

En tilkobling som kobles til via lokal datagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

OnPremisesGatewayPersonalConnection

Objekt

En tilkobling som kobles til via en personlig lokal datagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: OnPremisesGatewayPersonal	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

PersonalCloudConnection

Objekt

En tilkobling som kobles til via skyen og ikke kan deles.

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: PersonalCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

PrivacyLevel

Opplisting

Innstillingen for personvernnivå for tilkoblingen. Flere personvernnivåer kan legges til over tid.

Verdi	Beskrivelse
None	Ingen innstilling for personvernnivå er konfigurert.
Private	Tilkoblinger som er satt til privat, inneholder sensitiv eller konfidensiell informasjon. Synlighet kan begrenses til autoriserte brukere. Data fra en privat tilkobling vil ikke foldes inn i andre tilkoblinger, inkludert andre private tilkoblinger.
Organizational	Tilkoblinger som er satt til organisatoriske, kan foldes inn i private og andre organisatoriske tilkoblinger. De kan ikke kaste seg inn i offentlige tilkoblinger. Synlighet er satt til en klarert gruppe.
Public	Filer, Internett-tilkoblinger og arbeidsbokdata kan settes til offentlig. Data kan brettes inn i andre tilkoblinger. Synlighet er tilgjengelig for alle.

ShareableCloudConnection

Objekt

En tilkobling som kobles til via skyen.

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
allowUsageInUserControlledCode	boolean	Tillat at denne tilkoblingen brukes med elementer som tillater brukerstyrt kode, for eksempel notatblokk.
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

SingleSignOnType

Opplisting

Enkel påloggingstype for tilkoblingen. Flere typer enkel pålogging kan legges til over tid.

Verdi	Beskrivelse
None	Tilkoblingen bruker ikke enkel pålogging for å koble til.
Kerberos	Tilkobling bruker Kerberos enkel pålogging til å koble til.
MicrosoftEntraID	Tilkobling bruker enkel pålogging for Microsoft Entra ID til å koble til.
SecurityAssertionMarkupLanguage	Tilkobling bruker SAML (Security Assertion Markup Language) enkel pålogging for å koble til.
KerberosDirectQueryAndRefresh	Tilkobling bruker Kerberos DirectQuery og Oppdater enkel pålogging for å koble til.

StreamingVirtualNetworkGatewayConnection

Objekt

En tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: StreamingVirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

VirtualNetworkGatewayConnection

Objekt

En tilkobling som kobles til via en virtuell nettverksdatagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.