Connections - Create Connection

Tjänst:: Core

API-version:: v1

Skapar en anslutning.
Information om hur du krypterar autentiseringsuppgifter finns i Konfigurera autentiseringsuppgifter programmatiskt.

Permissions

Om du skapar en gatewayanslutning måste anroparen ha behörighet för gatewayen..
Tjänstens huvudnamn måste ha behörighet beviljad av Infrastrukturresursadministratör. Mer information finns i: Tjänstens huvudnamn kan skapa arbetsytor, anslutningar och distributionspipelines.

Obligatoriska delegerade omfång

Connection.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Yes
Tjänstens huvudnamn och hanterade identiteter	Yes

Interface

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

Begärandetext

Brödtexten i begäran kan vara något av följande:

Name	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name	Obligatorisk	Typ	Description
connectionDetails	True	CreateConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	True	string: ShareableCloud	Anslutningens anslutningstyp.
credentialDetails	True	CreateCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	True	string	Anslutningens visningsnamn. Maximal längd är 200 tecken.
allowConnectionUsageInGateway		boolean	Tillåt att den här anslutningen används med antingen lokala datagatewayer eller VNet-datagatewayer.
privacyLevel		PrivacyLevel	(Valfritt) Sekretessnivån för anslutningen. När inget värde skickas anges detta till "Organisation".

CreateOnPremisesConnectionRequest

Name	Obligatorisk	Typ	Description
connectionDetails	True	CreateConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	True	string: OnPremisesGateway	Anslutningens anslutningstyp.
credentialDetails	True	CreateOnPremisesCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	True	string	Anslutningens visningsnamn. Maximal längd är 200 tecken.
gatewayId	True	string (uuid)	Objekt-ID för den primära gatewayen för den lokala gatewayen som anslutningen skapas under.
privacyLevel		PrivacyLevel	(Valfritt) Sekretessnivån för anslutningen. När inget värde skickas anges detta till "Organisation".

CreateVirtualNetworkGatewayConnectionRequest

Name	Obligatorisk	Typ	Description
connectionDetails	True	CreateConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	True	string: VirtualNetworkGateway	Anslutningens anslutningstyp.
credentialDetails	True	CreateCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	True	string	Anslutningens visningsnamn. Maximal längd är 200 tecken.
gatewayId	True	string (uuid)	Objekt-ID för den virtuella nätverksgatewayen som anslutningen skapas under.
privacyLevel		PrivacyLevel	(Valfritt) Sekretessnivån för anslutningen. När inget värde skickas anges detta till "Organisation".

Svar

Name	Typ	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Åtgärden lyckades.
Other Status Codes	ErrorResponse	Vanliga felkoder: DuplicateConnectionName – Anslutningsnamnet används redan. InvalidConnectionDetails – ConnectionDetails-indata är inte giltiga. InvalidCredentialDetails – Indata från CredentialDetails är inte giltiga. IncorrectCredentials – Det gick inte att upprätta anslutningen med indata för autentiseringsuppgifter. CreateGatewayConnectionFailed – Det gick inte att skapa gatewayanslutningen.

Name

Typ

Description

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. Åtgärden lyckades.

Other Status Codes

ErrorResponse

Vanliga felkoder:

DuplicateConnectionName – Anslutningsnamnet används redan.
InvalidConnectionDetails – ConnectionDetails-indata är inte giltiga.
InvalidCredentialDetails – Indata från CredentialDetails är inte giltiga.
IncorrectCredentials – Det gick inte att upprätta anslutningen med indata för autentiseringsuppgifter.
CreateGatewayConnectionFailed – Det gick inte att skapa gatewayanslutningen.

Exempel

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

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": "************************************"
        }
      ]
    }
  }
}

Exempelsvar

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
AnonymousCredentials	Autentiseringsuppgifter för Anonymous CredentialType.
BasicCredentials	Autentiseringsuppgifter för Basic CredentialType.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter för boolesk dataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter för datumdataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter för dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter för dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter för varaktighetsdataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter för taldataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter för textdataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter för tidsdataType.
ConnectionEncryption	Anslutningens anslutningskrypteringstyp. Ytterligare värden för anslutningskryptering kan läggas till över tid.
ConnectivityType	Anslutningens anslutningstyp. Ytterligare anslutningstyper kan läggas till över tid.
CreateCloudConnectionRequest
CreateConnectionDetails	Indata för anslutningsinformation för att skapa åtgärder.
CreateCredentialDetails	Indata för information om autentiseringsuppgifter för att skapa en anslutning.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Indata för autentiseringsuppgifter för att skapa en lokal gatewayanslutning.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Anslutningens typ av autentiseringsuppgifter. Ytterligare typer av autentiseringsuppgifter kan läggas till över tid.
DataType	Datatypen för parametervärdet för att skapa anslutningen. Ytterligare datatypsvärden kan läggas till över tid.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
KeyCredentials	Autentiseringsuppgifter för Key CredentialType.
ListConnectionDetails	Utdata för anslutningsinformation för liståtgärder.
ListCredentialDetails	Information om autentiseringsuppgifter som returneras när en anslutning hämtas.
OnPremisesCredentialEntry	Ett gateway-ID och dess krypterade serialiserade autentiseringsuppgifter.
OnPremisesGatewayConnection	En anslutning som ansluter via en lokal datagateway.
OnPremisesGatewayCredentials	Autentiseringsuppgifter för autentisering via en lokal gateway.
OnPremisesGatewayPersonalConnection	En anslutning som ansluter via en personlig lokal datagateway.
PersonalCloudConnection	En anslutning som ansluter via molnet och inte kan delas.
PrivacyLevel	Inställningen för sekretessnivå för anslutningen. Ytterligare sekretessnivåer kan läggas till över tid.
ServicePrincipalCredentials	Autentiseringsuppgifter för ServicePrincipal CredentialType.
ShareableCloudConnection	En anslutning som ansluter via molnet.
SharedAccessSignatureCredentials	Autentiseringsuppgifter för SharedAccessSignature CredentialType.
SingleSignOnType	Anslutningstypen för enkel inloggning. Ytterligare typer av enkel inloggning kan läggas till över tid.
VirtualNetworkGatewayConnection	En anslutning som ansluter via en virtuell nätverksdatagateway.
WindowsCredentials	Autentiseringsuppgifter för Windows CredentialType.
WindowsWithoutImpersonationCredentials	Autentiseringsuppgifter för WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Autentiseringsuppgifter för WorkspaceIdentity CredentialType.

AnonymousCredentials

Objekt

Autentiseringsuppgifter för Anonymous CredentialType.

Name	Typ	Description
credentialType	string: Anonymous	Anslutningens typ av autentiseringsuppgifter.

BasicCredentials

Objekt

Autentiseringsuppgifter för Basic CredentialType.

Name	Typ	Description
credentialType	string: Basic	Anslutningens typ av autentiseringsuppgifter.
password	string	Lösenordet.
username	string	Användarnamnet.

ConnectionDetailsBooleanParameter

Objekt

ConnectionDetailsParameter för boolesk dataType.

Name	Typ	Description
dataType	string: Boolean	Parameterns datatyp.
name	string	Namnet på parametern.
value	boolean	Det booleska värdet.

ConnectionDetailsDateParameter

Objekt

ConnectionDetailsParameter för datumdataType.

Name	Typ	Description
dataType	string: Date	Parameterns datatyp.
name	string	Namnet på parametern.
value	string (date)	Datumvärdet med hjälp av YYYY-MM-DD format.

ConnectionDetailsDateTimeParameter

Objekt

ConnectionDetailsParameter för dateTime dataType.

Name	Typ	Description
dataType	string: DateTime	Parameterns datatyp.
name	string	Namnet på parametern.
value	string (date-time)	Datumtidsvärdet med hjälp av YYYY-MM-DDTHH:mm:ss. FFFZ-format.

ConnectionDetailsDateTimeZoneParameter

Objekt

ConnectionDetailsParameter för dateTimeZone dataType.

Name	Typ	Description
dataType	string: DateTimeZone	Parameterns datatyp.
name	string	Namnet på parametern.
value	string (date-time-offset)	Datumtidszonvärdet med hjälp av YYYY-MM-DDTHH:mm:ss. FFF±hh:mm format.

ConnectionDetailsDurationParameter

Objekt

ConnectionDetailsParameter för varaktighetsdataType.

Name	Typ	Description
dataType	string: Duration	Parameterns datatyp.
name	string	Namnet på parametern.
value	string (time-span)	Varaktighetsvärdet med formatet [-]P(n)DT(n)H(n)M(n)S. Till exempel: P3DT4H30M10S (i 3 dagar, 4 timmar, 30 minuter och 10 sekunder).

ConnectionDetailsNumberParameter

Objekt

ConnectionDetailsParameter för taldataType.

Name	Typ	Description
dataType	string: Number	Parameterns datatyp.
name	string	Namnet på parametern.
value	number	Talvärdet.

ConnectionDetailsTextParameter

Objekt

ConnectionDetailsParameter för textdataType.

Name	Typ	Description
dataType	string: Text	Parameterns datatyp.
name	string	Namnet på parametern.
value	string	Textvärdet.

ConnectionDetailsTimeParameter

Objekt

ConnectionDetailsParameter för tidsdataType.

Name	Typ	Description
dataType	string: Time	Parameterns datatyp.
name	string	Namnet på parametern.
value	string (time)	Tidsvärdet med HH:mm:ss. FFFZ-format.

ConnectionEncryption

Uppräkning

Anslutningens anslutningskrypteringstyp. Ytterligare värden för anslutningskryptering kan läggas till över tid.

Värde	Description
Encrypted	Anslutningsförsöket görs med hjälp av en krypterad anslutning.
Any	Anslutningsförsöket görs först med en krypterad anslutning och återgår sedan till okrypterad anslutning om det misslyckas.
NotEncrypted	Anslutningsförsöket görs med en okrypterad anslutning.

ConnectivityType

Uppräkning

Anslutningens anslutningstyp. Ytterligare anslutningstyper kan läggas till över tid.

Värde	Description
ShareableCloud	Anslutningen ansluter via molnet och kan delas med andra.
PersonalCloud	Anslutningen ansluter via molnet och kan inte delas med andra.
OnPremisesGateway	Anslutningen ansluter via en lokal datagateway.
OnPremisesGatewayPersonal	Anslutningen ansluter via en personlig lokal datagateway.
VirtualNetworkGateway	Anslutningen ansluter via en virtuell nätverksdatagateway.
Automatic	Anslutningen ansluter via molnet med hjälp av en implicit dataanslutning. Det här alternativet är endast tillgängligt för specifika scenarier som semantiska modeller som använder enkel Sign-On (SSO)."
None	Anslutningen är inte bunden

CreateCloudConnectionRequest

Objekt

Name	Typ	Description
allowConnectionUsageInGateway	boolean	Tillåt att den här anslutningen används med antingen lokala datagatewayer eller VNet-datagatewayer.
connectionDetails	CreateConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: ShareableCloud	Anslutningens anslutningstyp.
credentialDetails	CreateCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn. Maximal längd är 200 tecken.
privacyLevel	PrivacyLevel	(Valfritt) Sekretessnivån för anslutningen. När inget värde skickas anges detta till "Organisation".

CreateConnectionDetails

Objekt

Indata för anslutningsinformation för att skapa åtgärder.

Name	Typ	Description
creationMethod	string	Den skapandemetod som används för att skapa anslutningen. För en lista över skapandemetoder använder du API:et ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Listan över anslutningsparametrar. För en lista över parametrar för varje skapandemetod använder du API:et ListSupportedConnectionTypes .
type	string	Typen av anslutning.

CreateCredentialDetails

Objekt

Indata för information om autentiseringsuppgifter för att skapa en anslutning.

Name	Typ	Description
connectionEncryption	ConnectionEncryption	(Valfritt) Inställningen för anslutningskryptering som används under testanslutningen. När inget värde skickas krypteras inte anslutningen.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Anslutningens autentiseringsuppgifter.
singleSignOnType	SingleSignOnType	(Valfritt) Anslutningstypen för enkel inloggning. När inget värde skickas använder anslutningen inte enkel inloggning.
skipTestConnection	boolean	Om anslutningen ska hoppa över testanslutningen när den skapas och uppdateras. Sant – Hoppa över testanslutningen False – Hoppa inte över testanslutningen. När inget värde skickas är detta inställt på "False".

CreateOnPremisesConnectionRequest

Objekt

Name	Typ	Description
connectionDetails	CreateConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: OnPremisesGateway	Anslutningens anslutningstyp.
credentialDetails	CreateOnPremisesCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn. Maximal längd är 200 tecken.
gatewayId	string (uuid)	Objekt-ID för den primära gatewayen för den lokala gatewayen som anslutningen skapas under.
privacyLevel	PrivacyLevel	(Valfritt) Sekretessnivån för anslutningen. När inget värde skickas anges detta till "Organisation".

CreateOnPremisesCredentialDetails

Objekt

Indata för autentiseringsuppgifter för att skapa en lokal gatewayanslutning.

Name	Typ	Description
connectionEncryption	ConnectionEncryption	(Valfritt) Inställningen för anslutningskryptering som används under testanslutningen. När inget värde skickas krypteras inte anslutningen.
credentials	OnPremisesGatewayCredentials	Anslutningens autentiseringsuppgifter.
singleSignOnType	SingleSignOnType	(Valfritt) Anslutningstypen för enkel inloggning. När inget värde skickas använder anslutningen inte enkel inloggning.
skipTestConnection	boolean	Om anslutningen ska hoppa över testanslutningen när den skapas och uppdateras. Sant – Hoppa över testanslutningen False – Hoppa inte över testanslutningen. När inget värde skickas är detta inställt på "False".

CreateVirtualNetworkGatewayConnectionRequest

Objekt

Name	Typ	Description
connectionDetails	CreateConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: VirtualNetworkGateway	Anslutningens anslutningstyp.
credentialDetails	CreateCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn. Maximal längd är 200 tecken.
gatewayId	string (uuid)	Objekt-ID för den virtuella nätverksgatewayen som anslutningen skapas under.
privacyLevel	PrivacyLevel	(Valfritt) Sekretessnivån för anslutningen. När inget värde skickas anges detta till "Organisation".

CredentialType

Uppräkning

Anslutningens typ av autentiseringsuppgifter. Ytterligare typer av autentiseringsuppgifter kan läggas till över tid.

Värde	Description
Windows	Anslutningen använder Windows-autentisering för att ansluta. Stöds endast för lokala gatewayer.
Anonymous	Anslutningen använder anonym autentisering för att ansluta.
Basic	Anslutningen använder grundläggande autentisering för att ansluta.
Key	Anslutningen använder nyckelautentisering för att ansluta.
OAuth2	Anslutningen använder OAuth 2.0-autentisering för att ansluta.
WindowsWithoutImpersonation	Anslutningen använder Windows-autentisering (utan alternativet för personifiering) för att ansluta. Stöds endast för lokala gatewayer (personligt läge).
SharedAccessSignature	Anslutningen använder SAS-autentisering (signatur för delad åtkomst) för att ansluta.
ServicePrincipal	Anslutningen använder tjänstens huvudnamnsautentisering för att ansluta.
WorkspaceIdentity	Anslutningen använder identitetsautentisering för arbetsytan för att ansluta.

DataType

Uppräkning

Datatypen för parametervärdet för att skapa anslutningen. Ytterligare datatypsvärden kan läggas till över tid.

Värde	Description
Text	Använd text som parameterns indatavärde.
Number	Använd tal som parameterns indatavärde (heltal eller flyttal).
Boolean	Använd booleskt värde som parameterindatavärde. False – värdet är false, True – värdet är sant.
Duration	Använd varaktighet som parameterns indatavärde med formatet [-]P(n)DT(n)H(n)M(n)S. Till exempel: P3DT4H30M10S (i 3 dagar, 4 timmar, 30 minuter och 10 sekunder).
Date	Använd datum som parameterns indatavärde med hjälp av YYYY-MM-DD format.
DateTime	Använd datumtid som parameterns indatavärde med hjälp av YYYY-MM-DDTHH:mm:ss. FFFZ-format.
DateTimeZone	Använd datumtidszonen som parameterns indatavärde med hjälp av YYYY-MM-DDTHH:mm:ss. FFF±hh:mm format.
Time	Använd tid som parameterns indatavärde med hjälp av HH:mm:ss. FFFZ-format.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

KeyCredentials

Objekt

Autentiseringsuppgifter för Key CredentialType.

Name	Typ	Description
credentialType	string: Key	Anslutningens typ av autentiseringsuppgifter.
key	string	Nyckeln.

ListConnectionDetails

Objekt

Utdata för anslutningsinformation för liståtgärder.

Name	Typ	Description
path	string	Sökvägen till anslutningen.
type	string	Typen av anslutning.

ListCredentialDetails

Objekt

Information om autentiseringsuppgifter som returneras när en anslutning hämtas.

Name	Typ	Description
connectionEncryption	ConnectionEncryption	Inställningen för anslutningskryptering som används under testanslutningen.
credentialType	CredentialType	Anslutningens typ av autentiseringsuppgifter.
singleSignOnType	SingleSignOnType	Anslutningstypen för enkel inloggning.
skipTestConnection	boolean	Om anslutningen ska hoppa över testanslutningen när den skapas och uppdateras. Sant – Hoppa över testanslutningen False – Hoppa inte över testanslutningen.

OnPremisesCredentialEntry

Objekt

Ett gateway-ID och dess krypterade serialiserade autentiseringsuppgifter.

Name	Typ	Description
encryptedCredentials	string	Den krypterade serialiserade .json i listan med namnvärdepar. Namn är ett namn på autentiseringsuppgifter och värdet är ett värde för autentiseringsuppgifter. Kryptering utförs med hjälp av krypteringsalgoritmen Rivest-Shamir-Adleman (RSA) med den lokala gatewaymedlemmens offentliga nyckel.
gatewayId	string (uuid)	Gatewayens objekt-ID.

OnPremisesGatewayConnection

Objekt

En anslutning som ansluter via en lokal datagateway.

Name	Typ	Description
connectionDetails	ListConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: OnPremisesGateway	Anslutningens anslutningstyp.
credentialDetails	ListCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn.
gatewayId	string (uuid)	Gatewayobjektets ID för anslutningen.
id	string (uuid)	Objekt-ID för anslutningen.
privacyLevel	PrivacyLevel	Sekretessnivån för anslutningen.

OnPremisesGatewayCredentials

Objekt

Autentiseringsuppgifter för autentisering via en lokal gateway.

Name	Typ	Description
credentialType	CredentialType	Anslutningens typ av autentiseringsuppgifter.
values	OnPremisesCredentialEntry[]	Nyttolasten för autentiseringsuppgifter som ska skickas till den lokala gatewayen.

OnPremisesGatewayPersonalConnection

Objekt

En anslutning som ansluter via en personlig lokal datagateway.

Name	Typ	Description
connectionDetails	ListConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: OnPremisesGatewayPersonal	Anslutningens anslutningstyp.
credentialDetails	ListCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn.
gatewayId	string (uuid)	Gatewayobjektets ID för anslutningen.
id	string (uuid)	Objekt-ID för anslutningen.
privacyLevel	PrivacyLevel	Sekretessnivån för anslutningen.

PersonalCloudConnection

Objekt

En anslutning som ansluter via molnet och inte kan delas.

Name	Typ	Description
allowConnectionUsageInGateway	boolean	Tillåt att den här anslutningen används med antingen lokala datagatewayer eller VNet-datagatewayer.
connectionDetails	ListConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: PersonalCloud	Anslutningens anslutningstyp.
credentialDetails	ListCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn.
id	string (uuid)	Objekt-ID för anslutningen.
privacyLevel	PrivacyLevel	Sekretessnivån för anslutningen.

PrivacyLevel

Uppräkning

Inställningen för sekretessnivå för anslutningen. Ytterligare sekretessnivåer kan läggas till över tid.

Värde	Description
None	Ingen sekretessnivåinställning har konfigurerats.
Private	Anslutningar som är inställda på privat innehåller känslig eller konfidentiell information. Synligheten kan begränsas till behöriga användare. Data från en privat anslutning viks inte in i andra anslutningar, inklusive andra privata anslutningar.
Organizational	Anslutningar som är inställda på organisationen kan vika in till privata och andra organisationsanslutningar. De kan inte vika in till offentliga anslutningar. Synligheten är inställd på en betrodd grupp.
Public	Filer, Internetanslutningar och arbetsboksdata kan ställas in på offentliga. Data kan vika in till andra anslutningar. Synlighet är tillgängligt för alla.

ServicePrincipalCredentials

Objekt

Autentiseringsuppgifter för ServicePrincipal CredentialType.

Name	Typ	Description
credentialType	string: ServicePrincipal	Anslutningens typ av autentiseringsuppgifter.
servicePrincipalClientId	string (uuid)	Klient-ID för tjänstens huvudnamn.
servicePrincipalSecret	string	Hemligheten med tjänstens huvudnamn.
tenantId	string (uuid)	Klientorganisations-ID för tjänstens huvudnamn.

ShareableCloudConnection

Objekt

En anslutning som ansluter via molnet.

Name	Typ	Description
allowConnectionUsageInGateway	boolean	Tillåt att den här anslutningen används med antingen lokala datagatewayer eller VNet-datagatewayer.
connectionDetails	ListConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: ShareableCloud	Anslutningens anslutningstyp.
credentialDetails	ListCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn.
id	string (uuid)	Objekt-ID för anslutningen.
privacyLevel	PrivacyLevel	Sekretessnivån för anslutningen.

SharedAccessSignatureCredentials

Objekt

Autentiseringsuppgifter för SharedAccessSignature CredentialType.

Name	Typ	Description
credentialType	string: SharedAccessSignature	Anslutningens typ av autentiseringsuppgifter.
token	string	Token.

SingleSignOnType

Uppräkning

Anslutningstypen för enkel inloggning. Ytterligare typer av enkel inloggning kan läggas till över tid.

Värde	Description
None	Anslutningen använder inte enkel inloggning för att ansluta.
Kerberos	Anslutningen använder enkel inloggning med Kerberos för att ansluta.
MicrosoftEntraID	Anslutningen använder enkel inloggning med Microsoft Entra-ID för att ansluta.
SecurityAssertionMarkupLanguage	Anslutningen använder enkel inloggning med SAML (Security Assertion Markup Language) för att ansluta.
KerberosDirectQueryAndRefresh	Anslutningen använder enkel inloggning med Kerberos DirectQuery och Uppdatera för att ansluta.

VirtualNetworkGatewayConnection

Objekt

En anslutning som ansluter via en virtuell nätverksdatagateway.

Name	Typ	Description
connectionDetails	ListConnectionDetails	Anslutningsinformationen för anslutningen.
connectivityType	string: VirtualNetworkGateway	Anslutningens anslutningstyp.
credentialDetails	ListCredentialDetails	Information om anslutningens autentiseringsuppgifter.
displayName	string	Anslutningens visningsnamn.
gatewayId	string (uuid)	Gatewayobjektets ID för anslutningen.
id	string (uuid)	Objekt-ID för anslutningen.
privacyLevel	PrivacyLevel	Sekretessnivån för anslutningen.

WindowsCredentials

Objekt

Autentiseringsuppgifter för Windows CredentialType.

Name	Typ	Description
credentialType	string: Windows	Anslutningens typ av autentiseringsuppgifter.
password	string	Lösenordet.
username	string	Användarnamnet.

WindowsWithoutImpersonationCredentials

Objekt

Autentiseringsuppgifter för WindowsWithoutImpersonation CredentialType.

Name	Typ	Description
credentialType	string: WindowsWithoutImpersonation	Anslutningens typ av autentiseringsuppgifter.

WorkspaceIdentityCredentials

Objekt

Autentiseringsuppgifter för WorkspaceIdentity CredentialType.

Name	Typ	Description
credentialType	string: WorkspaceIdentity	Anslutningens typ av autentiseringsuppgifter.

Dela via

Connections - Create Connection

Permissions

Obligatoriska delegerade omfång

Identiteter som stöds av Microsoft Entra

Interface

Begärandetext

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Svar

Exempel

Cloud example

Exempelbegäran

Exempelsvar

On-premises gateway example

Exempelbegäran

Exempelsvar

Virtual network gateway example

Exempelbegäran

Exempelsvar

Definitioner

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