Connections - List Connections

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Palauttaa luettelon paikallisista näennäisverkoista ja pilviyhteyksistä, joihin käyttäjällä on käyttöoikeus.

Permissions

Soittajalla on oltava yhteyden käyttöoikeudet.

Vaaditut delegoidut vaikutusalueet

Connection.Read.All tai Connection.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identity	Support
User	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Interface

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

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
continuationToken	query		string	Tunnus seuraavan tulossivun noutamiseen.

Vastaukset

Nimi	Tyyppi	Description
200 OK	ListConnectionsResponse	OK. Toiminto onnistui.
Other Status Codes	ErrorResponse	Yleiset virhekoodit: UnknownError – Ilmeni virhe.

Nimi

Tyyppi

Description

200 OK

ListConnectionsResponse

OK. Toiminto onnistui.

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

UnknownError – Ilmeni virhe.

Esimerkit

Example

Mallipyyntö

HTTP

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

Mallivastaus

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

Määritelmät

Nimi	Description
ConnectionEncryption	Yhteyden salaustyyppi. Yhteyden salausarvoja 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.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ListConnectionDetails	Yhteyden tietojen tuloste luettelotoiminnoille.
ListConnectionsResponse
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.
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	Description
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ä.

ConnectivityType

Luettelointi

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

Arvo	Description
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.
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	Description
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.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

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

ErrorResponse

Object

Virhevastaus.

Nimi	Tyyppi	Description
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ä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
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ä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ListConnectionDetails

Object

Yhteyden tietojen tuloste luettelotoiminnoille.

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

ListConnectionsResponse

Object

Nimi	Tyyppi	Description
continuationToken	string	Seuraavan tulosjoukkoerän tunnus. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
continuationUri	string	Seuraavan tulosjoukkoerän URI. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
value	Connection[]: OnPremisesGatewayConnection[] OnPremisesGatewayPersonalConnection[] PersonalCloudConnection[] ShareableCloudConnection[] VirtualNetworkGatewayConnection[]	Palautettujen yhteyksien luettelo.

ListCredentialDetails

Object

Yhteyden noutamisen yhteydessä palautetut tunnistetietojen tiedot.

Nimi	Tyyppi	Description
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

Object

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

Nimi	Tyyppi	Description
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectivityType	string: OnPremisesGateway	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.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

OnPremisesGatewayPersonalConnection

Object

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

Nimi	Tyyppi	Description
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectivityType	string: OnPremisesGatewayPersonal	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.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

PersonalCloudConnection

Object

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

Nimi	Tyyppi	Description
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.
connectivityType	string: PersonalCloud	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
id	string (uuid)	Yhteyden objektitunnus.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

PrivacyLevel

Luettelointi

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

Arvo	Description
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

Object

Yhteys, joka muodostaa yhteyden pilvipalvelun kautta.

Nimi	Tyyppi	Description
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.
connectivityType	string: ShareableCloud	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
id	string (uuid)	Yhteyden objektitunnus.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

SingleSignOnType

Luettelointi

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

Arvo	Description
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.

VirtualNetworkGatewayConnection

Object

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

Nimi	Tyyppi	Description
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectivityType	string: VirtualNetworkGateway	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.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

Jaa kautta

Connections - List Connections

Permissions

Vaaditut delegoidut vaikutusalueet

Microsoft Entran tukemat käyttäjätiedot

Interface

URI-parametrit

Vastaukset

Esimerkit

Example

Mallipyyntö

Mallivastaus

Määritelmät

ConnectionEncryption

ConnectivityType

CredentialType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ListConnectionDetails

ListConnectionsResponse

ListCredentialDetails

OnPremisesGatewayConnection

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ShareableCloudConnection

SingleSignOnType

VirtualNetworkGatewayConnection