Connections - Create Connection

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Luo yhteyden.
Jos haluat salata tunnistetiedot, katso Tunnistetietojen määrittäminen ohjelmallisesti.

Permissions

Jos luot yhdyskäytäväyhteyden, soittajalla on oltava oikeudet yhdyskäytävään.
Palvelun päänimillä on oltava Fabric-järjestelmänvalvojan myöntämä käyttöoikeus. Lisätietoja on ohjeaiheessa Palvelun päänimet voivat luoda työtiloja, yhteyksiä ja käyttöönottoputkia.

Vaaditut delegoidut vaikutusalueet

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

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

Pyynnön leipäteksti

Pyynnön teksti voi olla jokin seuraavista:

Nimi	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Nimi	Pakollinen	Tyyppi	Description
connectionDetails	True	CreateConnectionDetails	Yhteyden tiedot.
connectivityType	True	string: ShareableCloud	Yhteyden yhteystyyppi.
credentialDetails	True	CreateCredentialDetails	Yhteyden tunnistetiedot.
displayName	True	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
allowConnectionUsageInGateway		boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
privacyLevel		PrivacyLevel	(Valinnainen) Yhteyden yksityisyystaso. Kun arvoa ei välitetään, sen arvoksi asetetaan "Organizational".

CreateOnPremisesConnectionRequest

Nimi	Pakollinen	Tyyppi	Description
connectionDetails	True	CreateConnectionDetails	Yhteyden tiedot.
connectivityType	True	string: OnPremisesGateway	Yhteyden yhteystyyppi.
credentialDetails	True	CreateOnPremisesCredentialDetails	Yhteyden tunnistetiedot.
displayName	True	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
gatewayId	True	string (uuid)	Se on sen paikallisen yhdyskäytävän ensisijaisen yhdyskäytävän objektitunnus, jossa yhteys on luotu.
privacyLevel		PrivacyLevel	(Valinnainen) Yhteyden yksityisyystaso. Kun arvoa ei välitetään, sen arvoksi asetetaan "Organizational".

CreateVirtualNetworkGatewayConnectionRequest

Nimi	Pakollinen	Tyyppi	Description
connectionDetails	True	CreateConnectionDetails	Yhteyden tiedot.
connectivityType	True	string: VirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	True	CreateCredentialDetails	Yhteyden tunnistetiedot.
displayName	True	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
gatewayId	True	string (uuid)	Sen näennäisverkkoyhdyskäytävän objektitunnus, jossa yhteys on luotu.
privacyLevel		PrivacyLevel	(Valinnainen) Yhteyden yksityisyystaso. Kun arvoa ei välitetään, sen arvoksi asetetaan "Organizational".

Vastaukset

Nimi	Tyyppi	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Toiminto onnistui.
Other Status Codes	ErrorResponse	Yleiset virhekoodit: DuplicateConnectionName – Yhteyden nimi on jo käytössä. InvalidConnectionDetails – Annettu ConnectionDetails-syöte ei ole kelvollinen. InvalidCredentialDetails – Annettu CredentialDetails-syöte ei ole kelvollinen. IncorrectCredentials – Yhteyden muodostaminen tunnistetietojen syötettä käyttämällä epäonnistui. CreateGatewayConnectionFailed – Yhdyskäytäväyhteyden luominen epäonnistui.

Nimi

Tyyppi

Description

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. Toiminto onnistui.

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

DuplicateConnectionName – Yhteyden nimi on jo käytössä.
InvalidConnectionDetails – Annettu ConnectionDetails-syöte ei ole kelvollinen.
InvalidCredentialDetails – Annettu CredentialDetails-syöte ei ole kelvollinen.
IncorrectCredentials – Yhteyden muodostaminen tunnistetietojen syötettä käyttämällä epäonnistui.
CreateGatewayConnectionFailed – Yhdyskäytäväyhteyden luominen epäonnistui.

Esimerkit

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Mallipyyntö

HTTP

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

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "********"
    }
  }
}

Mallivastaus

Tilakoodi:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

On-premises gateway example

Mallipyyntö

HTTP

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

{
  "connectivityType": "OnPremisesGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoOnPremisesConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "55226bab-5024-4b72-9716-6dc8ef3a97fe",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Mallivastaus

Tilakoodi:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoOnPremisesConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Virtual network gateway example

Mallipyyntö

HTTP

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

{
  "connectivityType": "VirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "*********"
    }
  }
}

Mallivastaus

Tilakoodi:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  }
}

Määritelmät

Nimi	Description
AnonymousCredentials	Anonyymin tunnistetietotyypin tunnistetiedot.
BasicCredentials	Perustunnistetietotyypin tunnistetiedot.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter for boolean dataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter for date dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter dateTime dataType -arvolle.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter dateTimeZone-tietotyypille.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter for duration dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter for number dataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter tekstille dataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter aikatietotyypille.
ConnectionEncryption	Yhteyden salaustyyppi. Yhteyden salausarvoja voidaan lisätä ajan mittaan.
ConnectivityType	Yhteyden yhteystyyppi. Muita yhteystyyppejä voidaan lisätä ajan mittaan.
CreateCloudConnectionRequest
CreateConnectionDetails	Luontitoimintojen yhteyden tietojen syöte.
CreateCredentialDetails	Tunnistetietojen syöte yhteyden luomista varten.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Tunnistetietojen syöte paikallisen yhdyskäytäväyhteyden luontia varten.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Yhteyden tunnistetietotyyppi. Muita tunnistetietotyyppejä voidaan lisätä ajan mittaan.
DataType	Yhteyden luomisen parametriarvon tietotyyppi. Lisää tietotyyppiarvoja voidaan lisätä ajan mittaan.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
KeyCredentials	Avaimen tunnistetietotyypin tunnistetiedot.
ListConnectionDetails	Yhteyden tietojen tuloste luettelotoiminnoille.
ListCredentialDetails	Yhteyden noutamisen yhteydessä palautetut tunnistetietojen tiedot.
OnPremisesCredentialEntry	Yhdyskäytävän tunnus ja sen salatut sarjoitetut tunnistetiedot.
OnPremisesGatewayConnection	Yhteys, joka muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.
OnPremisesGatewayCredentials	Tunnistetiedot todentamiseen paikallisen yhdyskä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.
ServicePrincipalCredentials	ServicePrincipal-tunnistetietotyypin tunnistetiedot.
ShareableCloudConnection	Yhteys, joka muodostaa yhteyden pilvipalvelun kautta.
SharedAccessSignatureCredentials	SharedAccessSignature-tunnistetietotyypin tunnistetiedot.
SingleSignOnType	Yhteyden kertakirjautumistyyppi. Muita kertakirjautumistyyppejä voidaan lisätä ajan mittaan.
VirtualNetworkGatewayConnection	Yhteys, joka muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.
WindowsCredentials	Windowsin tunnistetietotyypin tunnistetiedot.
WindowsWithoutImpersonationCredentials	WindowsWithoutImpersonation-tunnistetietotyypin tunnistetiedot.
WorkspaceIdentityCredentials	WorkspaceIdentity CredentialType-asetuksen tunnistetiedot.

AnonymousCredentials

Object

Anonyymin tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: Anonymous	Yhteyden tunnistetietotyyppi.

BasicCredentials

Object

Perustunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: Basic	Yhteyden tunnistetietotyyppi.
password	string	Salasana.
username	string	Käyttäjänimi.

ConnectionDetailsBooleanParameter

Object

ConnectionDetailsParameter for boolean dataType.

Nimi	Tyyppi	Description
dataType	string: Boolean	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	boolean	Totuusarvo.

ConnectionDetailsDateParameter

Object

ConnectionDetailsParameter for date dataType.

Nimi	Tyyppi	Description
dataType	string: Date	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	string (date)	Päivämääräarvo muodossa YYYY–MM-DD.

ConnectionDetailsDateTimeParameter

Object

ConnectionDetailsParameter dateTime dataType -arvolle.

Nimi	Tyyppi	Description
dataType	string: DateTime	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	string (date-time)	Päivämäärän ja kellonajan arvo, kun käytössä on VVVV-KK-PPTHH:mm:ss. FFFZ-muoto.

ConnectionDetailsDateTimeZoneParameter

Object

ConnectionDetailsParameter dateTimeZone-tietotyypille.

Nimi	Tyyppi	Description
dataType	string: DateTimeZone	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	string (date-time-offset)	Päivämäärän aikavyöhykearvo käyttäen VVVV-KK-PPTHH:mm:ss-arvoa. FFF±hh:mm-muoto.

ConnectionDetailsDurationParameter

Object

ConnectionDetailsParameter for duration dataType.

Nimi	Tyyppi	Description
dataType	string: Duration	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	string (time-span)	Kestoarvo käyttäen muotoa [-]P(n)DT(n)H(n)M(n)S. Esimerkki: P3DT4H30M10S (kolme päivää, 4 tuntia, 30 minuuttia ja 10 sekuntia).

ConnectionDetailsNumberParameter

Object

ConnectionDetailsParameter for number dataType.

Nimi	Tyyppi	Description
dataType	string: Number	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	number	Lukuarvo.

ConnectionDetailsTextParameter

Object

ConnectionDetailsParameter tekstille dataType.

Nimi	Tyyppi	Description
dataType	string: Text	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	string	Tekstiarvo.

ConnectionDetailsTimeParameter

Object

ConnectionDetailsParameter aikatietotyypille.

Nimi	Tyyppi	Description
dataType	string: Time	Parametrin tietotyyppi.
name	string	Parametrin nimi.
value	string (time)	Aika-arvo käyttäen arvoa HH:mm:ss. FFFZ-muoto.

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

CreateCloudConnectionRequest

Object

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	CreateConnectionDetails	Yhteyden tiedot.
connectivityType	string: ShareableCloud	Yhteyden yhteystyyppi.
credentialDetails	CreateCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel	PrivacyLevel	(Valinnainen) Yhteyden yksityisyystaso. Kun arvoa ei välitetään, sen arvoksi asetetaan "Organizational".

CreateConnectionDetails

Object

Luontitoimintojen yhteyden tietojen syöte.

Nimi	Tyyppi	Description
creationMethod	string	Luontimenetelmä, jota käytetään yhteyden luomiseen. Luontimenetelmäluettelossa käytetään ListSupportedConnectionTypes-ohjelmointirajapintaa .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Yhteysparametrien luettelo. Käytä kunkin luontimenetelmän parametriluettelossa ListSupportedConnectionTypes-ohjelmointirajapintaa .
type	string	Yhteyden tyyppi.

CreateCredentialDetails

Object

Tunnistetietojen syöte yhteyden luomista varten.

Nimi	Tyyppi	Description
connectionEncryption	ConnectionEncryption	(Valinnainen) Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana. Kun arvoa ei välitetty, yhteyttä ei salata.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Yhteyden tunnistetiedot.
singleSignOnType	SingleSignOnType	(Valinnainen) Yhteyden kertakirjautumistyyppi. Kun arvoa ei välitetä, yhteys ei käytä kertakirjautumista.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä. Kun arvoa ei välitetään, sen arvoksi asetetaan Epätosi.

CreateOnPremisesConnectionRequest

Object

Nimi	Tyyppi	Description
connectionDetails	CreateConnectionDetails	Yhteyden tiedot.
connectivityType	string: OnPremisesGateway	Yhteyden yhteystyyppi.
credentialDetails	CreateOnPremisesCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
gatewayId	string (uuid)	Se on sen paikallisen yhdyskäytävän ensisijaisen yhdyskäytävän objektitunnus, jossa yhteys on luotu.
privacyLevel	PrivacyLevel	(Valinnainen) Yhteyden yksityisyystaso. Kun arvoa ei välitetään, sen arvoksi asetetaan "Organizational".

CreateOnPremisesCredentialDetails

Object

Tunnistetietojen syöte paikallisen yhdyskäytäväyhteyden luontia varten.

Nimi	Tyyppi	Description
connectionEncryption	ConnectionEncryption	(Valinnainen) Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana. Kun arvoa ei välitetty, yhteyttä ei salata.
credentials	OnPremisesGatewayCredentials	Yhteyden tunnistetiedot.
singleSignOnType	SingleSignOnType	(Valinnainen) Yhteyden kertakirjautumistyyppi. Kun arvoa ei välitetä, yhteys ei käytä kertakirjautumista.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä. Kun arvoa ei välitetään, sen arvoksi asetetaan Epätosi.

CreateVirtualNetworkGatewayConnectionRequest

Object

Nimi	Tyyppi	Description
connectionDetails	CreateConnectionDetails	Yhteyden tiedot.
connectivityType	string: VirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	CreateCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
gatewayId	string (uuid)	Sen näennäisverkkoyhdyskäytävän objektitunnus, jossa yhteys on luotu.
privacyLevel	PrivacyLevel	(Valinnainen) Yhteyden yksityisyystaso. Kun arvoa ei välitetään, sen arvoksi asetetaan "Organizational".

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.

DataType

Luettelointi

Yhteyden luomisen parametriarvon tietotyyppi. Lisää tietotyyppiarvoja voidaan lisätä ajan mittaan.

Arvo	Description
Text	Käytä tekstiä parametrin syötearvona.
Number	Käytä lukua parametrin syötearvona (kokonaisluku tai liukuluku).
Boolean	Käytä parametrin syötearvona totuusarvoa. False – arvo on false, True – arvo on true.
Duration	Käytä kestoa parametrin syötearvona käyttäen [-]P(n)DT(n)H(n)M(n)S-muotoa. Esimerkki: P3DT4H30M10S (kolme päivää, 4 tuntia, 30 minuuttia ja 10 sekuntia).
Date	Käytä päivämäärää parametrin syötearvona käyttäen VVVV-MM-DD-muotoa.
DateTime	Käytä päivämäärää-aikaa parametrin syötearvona käyttäen VVVV-KK-PPTHH:mm:ss-funktiota. FFFZ-muoto.
DateTimeZone	Käytä parametrin syötearvona päivämäärän aikavyöhykettä käyttäen VVVV-KK-PPTHH:mm:ss-funktiota. FFF±hh:mm-muoto.
Time	Käytä aikaa parametrin syötearvona käyttäen arvoa HH:mm:ss. FFFZ-muoto.

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.

KeyCredentials

Object

Avaimen tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: Key	Yhteyden tunnistetietotyyppi.
key	string	Avain.

ListConnectionDetails

Object

Yhteyden tietojen tuloste luettelotoiminnoille.

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

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

OnPremisesCredentialEntry

Object

Yhdyskäytävän tunnus ja sen salatut sarjoitetut tunnistetiedot.

Nimi	Tyyppi	Description
encryptedCredentials	string	Salattu sarjoitettu .json nimiarvoparien luettelosta. Nimi on tunnistetietojen nimi ja arvo on tunnistetietoarvo. Salaus suoritetaan käyttämällä Rivest-Shamir-Adleman (RSA) -salausalgoritmia paikallisen yhdyskäytävän jäsenen julkisella avaimella.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus.

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.

OnPremisesGatewayCredentials

Object

Tunnistetiedot todentamiseen paikallisen yhdyskäytävän kautta.

Nimi	Tyyppi	Description
credentialType	CredentialType	Yhteyden tunnistetietotyyppi.
values	OnPremisesCredentialEntry[]	Tunnistetietojen tiedot, jotka lähetetään paikalliseen yhdyskäytävään.

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

ServicePrincipalCredentials

Object

ServicePrincipal-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: ServicePrincipal	Yhteyden tunnistetietotyyppi.
servicePrincipalClientId	string (uuid)	Palvelun päänimen asiakastunnus.
servicePrincipalSecret	string	Palvelun päänimen salaisuus.
tenantId	string (uuid)	Palvelun päänimen vuokraajatunnus.

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.

SharedAccessSignatureCredentials

Object

SharedAccessSignature-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: SharedAccessSignature	Yhteyden tunnistetietotyyppi.
token	string	Tunnus.

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.

WindowsCredentials

Object

Windowsin tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: Windows	Yhteyden tunnistetietotyyppi.
password	string	Salasana.
username	string	Käyttäjänimi.

WindowsWithoutImpersonationCredentials

Object

WindowsWithoutImpersonation-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: WindowsWithoutImpersonation	Yhteyden tunnistetietotyyppi.

WorkspaceIdentityCredentials

Object

WorkspaceIdentity CredentialType-asetuksen tunnistetiedot.

Nimi	Tyyppi	Description
credentialType	string: WorkspaceIdentity	Yhteyden tunnistetietotyyppi.

Jaa kautta

Connections - Create Connection

Permissions

Vaaditut delegoidut vaikutusalueet

Microsoft Entran tukemat käyttäjätiedot

Interface

Pyynnön leipäteksti

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Vastaukset

Esimerkit

Cloud example

Mallipyyntö

Mallivastaus

On-premises gateway example

Mallipyyntö

Mallivastaus

Virtual network gateway example

Mallipyyntö

Mallivastaus

Määritelmät

AnonymousCredentials

BasicCredentials

ConnectionDetailsBooleanParameter

ConnectionDetailsDateParameter

ConnectionDetailsDateTimeParameter

ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsDurationParameter

ConnectionDetailsNumberParameter

ConnectionDetailsTextParameter

ConnectionDetailsTimeParameter

ConnectionEncryption

ConnectivityType

CreateCloudConnectionRequest

CreateConnectionDetails

CreateCredentialDetails

CreateOnPremisesConnectionRequest

CreateOnPremisesCredentialDetails

CreateVirtualNetworkGatewayConnectionRequest

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayConnection

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ServicePrincipalCredentials

ShareableCloudConnection

SharedAccessSignatureCredentials

SingleSignOnType

VirtualNetworkGatewayConnection

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials