Connections - Get Connection

Palvelu:: Admin

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyn yhteyden.

Note

Fabric vuokraajan järjestelmänvalvojan yhteyksien hallinta on tällä hetkellä esikatseluvaiheessa (lisätietoja).

Permissions

Soittajan on oltava Fabric-järjestelmänvalvoja tai todennettava palvelun päänimen avulla.

Vaaditut delegoidut vaikutusalueet

Tenant.Read.All tai Tenant.ReadWrite.All

Rajoitukset

Ei mitään.

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft identities.

Identity	Tuki
Käyttäjä	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Interface

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
connectionId	path	True	string (uuid)	Yhteystunnus.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OKEI. Toiminto onnistui.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: EntityNotFound – Pyydettyä resurssia ei löytynyt.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OKEI. Toiminto onnistui.

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

EntityNotFound – Pyydettyä resurssia ei löytynyt.

Esimerkit

Get connection as admin example

Mallipyyntö

HTTP

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

Mallivastaus

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

Määritelmät

Nimi	Kuvaus
ConnectionEncryption	Yhteyden salaustyyppi. Yhteyden salausarvoja voidaan lisätä ajan mittaan.
ConnectionRecency	Edustaa yhteyden suoritetietojen tietoja.
ConnectionRole	Yhteysrooli. Lisää yhteysrooleja voidaan lisätä ajan mittaan.
ConnectivityType	Yhteyden yhteystyyppi. Muita yhteystyyppejä voidaan lisätä ajan mittaan.
CredentialType	Yhteyden tunnistetietotyyppi. Muita tunnistetietotyyppejä voidaan lisätä ajan mittaan.
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ListConnectionDetails	Yhteyden tietojen tuloste luettelotoiminnoille.
ListCredentialDetails	Yhteyden noutamisen yhteydessä palautetut tunnistetietojen tiedot.
OnPremisesGatewayConnection	Yhteys, joka muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.
OnPremisesGatewayPersonalConnection	Yhteys, joka muodostaa yhteyden henkilökohtaisen paikallisen tietoyhdyskäytävän kautta.
PersonalCloudConnection	Yhteys, joka muodostaa yhteyden pilvipalvelun kautta eikä sitä voi jakaa.
PrivacyLevel	Yhteyden yksityisyystaso. Lisää yksityisyystasoja voidaan lisätä ajan mittaan.
ShareableCloudConnection	Yhteys, joka muodostaa yhteyden pilvipalvelun kautta.
SingleSignOnType	Yhteyden kertakirjautumistyyppi. Muita kertakirjautumistyyppejä voidaan lisätä ajan mittaan.
StreamingVirtualNetworkGatewayConnection	Yhteys, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.
VirtualNetworkGatewayConnection	Yhteys, joka muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.

ConnectionEncryption

Luettelointi

Yhteyden salaustyyppi. Yhteyden salausarvoja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Encrypted	Yhteysyritys tehdään salatulla yhteydellä.
Any	Yhteysyritys tehdään ensin salatulla yhteydellä, joka sitten palaa salaamattomaan yhteyteen, jos se epäonnistuu.
NotEncrypted	Yhteysyritys tehdään salaamattomalla yhteydellä.

ConnectionRecency

Kohde

Edustaa yhteyden suoritetietojen tietoja.

Nimi	Tyyppi	Kuvaus
createdDateTime	string (date-time)	Aikaleima, kun yhteys luotiin UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Aikaleima, jolloin yhteys viimeksi sidottiin mihin tahansa UTC-kohteeseen muodossa VVVV-KK-PPTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Aikaleima, jolloin yhteyden tunnistetietoja viimeksi käytettiin UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Aikaleima, jolloin UTC-käyttäjä viimeksi sitoi yhteyden mihin tahansa kohteeseen muodossa VVVVV-KK-PPTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Aikaleima yhteyden tunnistetietojen viimeksi UTC-kirjautumistunnuksista käyttämällä VVVV-KK-PPTHH:mm:ssZ-muotoa.

ConnectionRole

Luettelointi

Yhteysrooli. Lisää yhteysrooleja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
User	Mahdollistaa yhteyden käytön käyttäjälle.
UserWithReshare	Sallii käyttäjälle yhteyden uudelleenjakamisoikeuden.
Owner	Mahdollistaa yhteyden omistajuuden.
PendingOwner	Yhteyden omistajuus ei ole vielä voimassa. -päänimen on päivitettävä yhteyden tunnistetiedot ( yhteyden ohjelmointirajapinnan päivityksen avulla), jotta se on tehokas.

ConnectivityType

Luettelointi

Yhteyden yhteystyyppi. Muita yhteystyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
ShareableCloud	Yhteys muodostaa yhteyden pilvipalvelun kautta ja voidaan jakaa muiden kanssa.
PersonalCloud	Yhteys muodostaa yhteyden pilvipalvelun kautta, eikä sitä voi jakaa muiden kanssa.
OnPremisesGateway	Yhteys muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.
OnPremisesGatewayPersonal	Yhteys muodostaa yhteyden henkilökohtaisen paikallisen tietoyhdyskäytävän kautta.
VirtualNetworkGateway	Yhteys muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.
StreamingVirtualNetworkGateway	Yhteys muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.
Automatic	Yhteys muodostaa yhteyden pilvipalvelun kautta implisiittisen tietoyhteyden avulla. Tämä vaihtoehto on käytettävissä vain tietyissä tilanteissa, kuten semanttisissa malleissa, joissa käytetään yksittäistä Sign-On (SSO).
None	Yhteyttä ei ole sidottu

CredentialType

Luettelointi

Yhteyden tunnistetietotyyppi. Muita tunnistetietotyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Windows	Yhteys muodostaa yhteyden Windows-todennuksen avulla. Vain paikalliset yhdyskäytävät tukevat tätä.
Anonymous	Yhteys muodostaa yhteyden anonyymin todennuksen avulla.
Basic	Yhteys muodostaa yhteyden perustodennuksen avulla.
Key	Yhteys muodostaa yhteyden avaintodennuksen avulla.
OAuth2	Yhteys käyttää OAuth 2.0 -todennusta yhteyden muodostamiseen.
WindowsWithoutImpersonation	Yhteys käyttää Windows-todennusta (ilman tekeytymisvaihtoehtoa). Vain paikalliset yhdyskäytävät (henkilökohtainen tila) tukevat tätä.
SharedAccessSignature	Yhteys käyttää SAS-todennusta yhteyden muodostamiseen.
ServicePrincipal	Yhteys muodostaa yhteyden palvelun päänimen todentamisen avulla.
WorkspaceIdentity	Yhteys muodostaa yhteyden työtilan käyttäjätietojen todennuksen avulla.
KeyPair	Yhteys muodostaa yhteyden avainparitodennuksen avulla.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ListConnectionDetails

Kohde

Yhteyden tietojen tuloste luettelotoiminnoille.

Nimi	Tyyppi	Kuvaus
path	string	Yhteyden polku.
type	string	Yhteyden tyyppi.

ListCredentialDetails

Kohde

Yhteyden noutamisen yhteydessä palautetut tunnistetietojen tiedot.

Nimi	Tyyppi	Kuvaus
connectionEncryption	ConnectionEncryption	Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana.
credentialType	CredentialType	Yhteyden tunnistetietotyyppi.
singleSignOnType	SingleSignOnType	Yhteyden kertakirjautumistyyppi.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä.

OnPremisesGatewayConnection

Kohde

Yhteys, joka muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: OnPremisesGateway	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

OnPremisesGatewayPersonalConnection

Kohde

Yhteys, joka muodostaa yhteyden henkilökohtaisen paikallisen tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: OnPremisesGatewayPersonal	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

PersonalCloudConnection

Kohde

Yhteys, joka muodostaa yhteyden pilvipalvelun kautta eikä sitä voi jakaa.

Nimi	Tyyppi	Kuvaus
allowConnectionUsageInGateway	boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: PersonalCloud	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

PrivacyLevel

Luettelointi

Yhteyden yksityisyystaso. Lisää yksityisyystasoja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
None	Tietosuojatason asetusta ei ole määritetty.
Private	Yksityisille yhteyksille määritetään arkaluonteisia tai luottamuksellisia tietoja. Näkyvyys voidaan rajata valtuutetuille käyttäjille. Yksityisestä yhteydestä peräisin olevia tietoja ei taiteta muihin yhteyksiin, mukaan lukien muihin yksityisyhteyksiin.
Organizational	Organisaation määrittämät yhteydet voivat taittua yksityisiin ja muihin organisaatioyhteyksiin. He eivät voi taittua julkisiin yhteyksiin. Näkyvyys on määritetty luotetuksi ryhmäksi.
Public	Tiedostot, Internet-yhteydet ja työkirjatiedot voidaan asettaa julkisiksi. Tiedot voidaan delegoida muihin yhteyksiin. Näkyvyys on kaikkien käytettävissä.

ShareableCloudConnection

Kohde

Yhteys, joka muodostaa yhteyden pilvipalvelun kautta.

Nimi	Tyyppi	Kuvaus
allowConnectionUsageInGateway	boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
allowUsageInUserControlledCode	boolean	Salli tämän yhteyden käyttö kohteissa, jotka sallivat käyttäjän hallitseman koodin, kuten Muistikirja.
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: ShareableCloud	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

SingleSignOnType

Luettelointi

Yhteyden kertakirjautumistyyppi. Muita kertakirjautumistyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
None	Yhteys ei käytä kertakirjautumista yhteyden muodostamiseen.
Kerberos	Yhteys muodostaa yhteyden Kerberoksen kertakirjautumisen avulla.
MicrosoftEntraID	Yhteys muodostaa yhteyden Microsoft Entra ID -kertakirjautumisen avulla.
SecurityAssertionMarkupLanguage	Yhteys käyttää Security Assertion Markup Languagen (SAML) kertakirjautumista yhteyden muodostamiseen.
KerberosDirectQueryAndRefresh	Yhteys muodostaa yhteyden Kerberos DirectQueryn ja Päivitä-kertakirjautumisen avulla.

StreamingVirtualNetworkGatewayConnection

Kohde

Yhteys, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: StreamingVirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhteyden yhdyskäytävän objektitunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

VirtualNetworkGatewayConnection

Kohde

Yhteys, joka muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: VirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.