Connections - Create Connection

Tjeneste:: Core

API-version:: v1

Opretter en forbindelse.
Hvis du vil kryptere legitimationsoplysninger, skal du se Konfigurer legitimationsoplysninger programmatisk.

Permissions

Hvis der oprettes en gatewayforbindelse, skal den, der ringer op, have tilladelser til gatewayen.
Tjenesteprincipaler skal have tilladelse fra Fabric-administratoren. Du kan få flere oplysninger under: Tjenesteprincipaler kan oprette arbejdsområder, forbindelser og udrulningspipelines.

Påkrævede delegerede områder

Connection.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Support
User	Yes
tjenesteprincipal og administrerede identiteter	Yes

Interface

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

Brødtekst for anmodning

Brødteksten i denne anmodning kan være en af følgende:

Name	Beskrivelse
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name	Påkrævet	Type	Beskrivelse
connectionDetails	True	CreateConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	True	string: ShareableCloud	Forbindelsestypen for forbindelsen.
credentialDetails	True	CreateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	True	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
allowConnectionUsageInGateway		boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
privacyLevel		PrivacyLevel	(Valgfrit) Niveauet for beskyttelse af personlige oplysninger for forbindelsen. Når der ikke overføres en værdi, angives den til 'Organisations'.

CreateOnPremisesConnectionRequest

Name	Påkrævet	Type	Beskrivelse
connectionDetails	True	CreateConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	True	string: OnPremisesGateway	Forbindelsestypen for forbindelsen.
credentialDetails	True	CreateOnPremisesCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	True	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
gatewayId	True	string (uuid)	Objekt-id'et for den primære gateway for gatewayen i det lokale miljø, som forbindelsen er oprettet under.
privacyLevel		PrivacyLevel	(Valgfrit) Niveauet for beskyttelse af personlige oplysninger for forbindelsen. Når der ikke overføres en værdi, angives den til 'Organisations'.

CreateVirtualNetworkGatewayConnectionRequest

Name	Påkrævet	Type	Beskrivelse
connectionDetails	True	CreateConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	True	string: VirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	True	CreateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	True	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
gatewayId	True	string (uuid)	Objekt-id'et for den virtuelle netværksgateway, som forbindelsen oprettes under.
privacyLevel		PrivacyLevel	(Valgfrit) Niveauet for beskyttelse af personlige oplysninger for forbindelsen. Når der ikke overføres en værdi, angives den til 'Organisations'.

Svar

Name	Type	Beskrivelse
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Handlingen blev udført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: DuplicateConnectionName – Forbindelsesnavnet er allerede i brug. InvalidConnectionDetails – Det angivne ConnectionDetails-input er ikke gyldigt. InvalidCredentialDetails – Inputtet CredentialDetails er ikke gyldigt. IncorrectCredentials – Der kunne ikke oprettes forbindelse ved hjælp af inputtet legitimationsoplysninger. CreateGatewayConnectionFailed – Gatewayforbindelsen kunne ikke oprettes.

Name

Type

Beskrivelse

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. Handlingen blev udført.

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

DuplicateConnectionName – Forbindelsesnavnet er allerede i brug.
InvalidConnectionDetails – Det angivne ConnectionDetails-input er ikke gyldigt.
InvalidCredentialDetails – Inputtet CredentialDetails er ikke gyldigt.
IncorrectCredentials – Der kunne ikke oprettes forbindelse ved hjælp af inputtet legitimationsoplysninger.
CreateGatewayConnectionFailed – Gatewayforbindelsen kunne ikke oprettes.

Eksempler

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Eksempelanmodning

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

Eksempelsvar

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

Eksempelanmodning

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

Eksempelsvar

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 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	Beskrivelse
AnonymousCredentials	Legitimationsoplysninger for Anonymous CredentialType.
BasicCredentials	Legitimationsoplysninger for Basic CredentialType.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter for boolesk dataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter for datodataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter for dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter for dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter for dataType for varighed.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter for number dataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter for tekstdataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter for time dataType.
ConnectionEncryption	Forbindelseskrypteringstypen for forbindelsen. Der kan tilføjes yderligere krypteringsværdier for forbindelsen over tid.
ConnectivityType	Forbindelsestypen for forbindelsen. Der kan tilføjes flere forbindelsestyper over tid.
CreateCloudConnectionRequest
CreateConnectionDetails	Inputtet for forbindelsesoplysninger for oprettelseshandlinger.
CreateCredentialDetails	Inputtet med legitimationsoplysninger til oprettelse af en forbindelse.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Inputtet med legitimationsoplysninger til oprettelse af en gatewayforbindelse i det lokale miljø.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Legitimationstypen for forbindelsen. Der kan tilføjes flere typer legitimationsoplysninger over tid.
DataType	Datatypen for parameterværdien for oprettelse af forbindelse. Der kan tilføjes flere datatypeværdier over tid.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
KeyCredentials	Legitimationsoplysninger for NøglelegitimationsoplysningerType.
ListConnectionDetails	Outputtet med forbindelsesoplysninger for listehandlinger.
ListCredentialDetails	De legitimationsoplysninger, der returneres, når der hentes en forbindelse.
OnPremisesCredentialEntry	Et gateway-id og dets krypterede serialiserede legitimationsoplysninger.
OnPremisesGatewayConnection	En forbindelse, der opretter forbindelse via datagatewayen i det lokale miljø.
OnPremisesGatewayCredentials	Legitimationsoplysninger til godkendelse via en gateway i det lokale miljø.
OnPremisesGatewayPersonalConnection	En forbindelse, der opretter forbindelse via en personlig datagateway i det lokale miljø.
PersonalCloudConnection	En forbindelse, der opretter forbindelse via cloudmiljøet og ikke kan deles.
PrivacyLevel	Indstillingen for niveauet for beskyttelse af personlige oplysninger for forbindelsen. Der kan tilføjes yderligere niveauer for beskyttelse af personlige oplysninger over tid.
ServicePrincipalCredentials	Legitimationsoplysninger for ServicePrincipal CredentialType.
ShareableCloudConnection	En forbindelse, der opretter forbindelse via cloudmiljøet.
SharedAccessSignatureCredentials	Legitimationsoplysninger for SharedAccessSignature CredentialType.
SingleSignOnType	Forbindelsestypen enkeltlogon. Der kan tilføjes flere enkeltlogontyper over tid.
VirtualNetworkGatewayConnection	En forbindelse, der opretter forbindelse via en virtuel netværksdatagateway.
WindowsCredentials	Legitimationsoplysninger for Windows CredentialType.
WindowsWithoutImpersonationCredentials	Legitimationsoplysninger for WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Legitimationsoplysninger for WorkspaceIdentity CredentialType.

AnonymousCredentials

Object

Legitimationsoplysninger for Anonymous CredentialType.

Name	Type	Beskrivelse
credentialType	string: Anonymous	Legitimationstypen for forbindelsen.

BasicCredentials

Object

Legitimationsoplysninger for Basic CredentialType.

Name	Type	Beskrivelse
credentialType	string: Basic	Legitimationstypen for forbindelsen.
password	string	Adgangskoden.
username	string	Brugernavnet.

ConnectionDetailsBooleanParameter

Object

ConnectionDetailsParameter for boolesk dataType.

Name	Type	Beskrivelse
dataType	string: Boolean	Parameterens datatype.
name	string	Navnet på parameteren.
value	boolean	Den booleske værdi.

ConnectionDetailsDateParameter

Object

ConnectionDetailsParameter for datodataType.

Name	Type	Beskrivelse
dataType	string: Date	Parameterens datatype.
name	string	Navnet på parameteren.
value	string (date)	Datoværdien ved hjælp af formatet YYYY-MM-DD.

ConnectionDetailsDateTimeParameter

Object

ConnectionDetailsParameter for dateTime dataType.

Name	Type	Beskrivelse
dataType	string: DateTime	Parameterens datatype.
name	string	Navnet på parameteren.
value	string (date-time)	Dato-klokkeslætsværdien ved hjælp af ÅÅÅÅ-MM-DDTHH:mm:ss. FFFZ-format.

ConnectionDetailsDateTimeZoneParameter

Object

ConnectionDetailsParameter for dateTimeZone dataType.

Name	Type	Beskrivelse
dataType	string: DateTimeZone	Parameterens datatype.
name	string	Navnet på parameteren.
value	string (date-time-offset)	Værdien for datotidszonen ved hjælp af ÅÅÅÅ-MM-DDTHH:mm:ss. FFF±hh:mm-format.

ConnectionDetailsDurationParameter

Object

ConnectionDetailsParameter for dataType for varighed.

Name	Type	Beskrivelse
dataType	string: Duration	Parameterens datatype.
name	string	Navnet på parameteren.
value	string (time-span)	Varighedsværdien ved hjælp af formatet [-]P(n)DT(n)H(n)M(n)S. For eksempel: P3DT4H30M10S (i 3 dage, 4 timer, 30 minutter og 10 sekunder).

ConnectionDetailsNumberParameter

Object

ConnectionDetailsParameter for number dataType.

Name	Type	Beskrivelse
dataType	string: Number	Parameterens datatype.
name	string	Navnet på parameteren.
value	number	Talværdien.

ConnectionDetailsTextParameter

Object

ConnectionDetailsParameter for tekstdataType.

Name	Type	Beskrivelse
dataType	string: Text	Parameterens datatype.
name	string	Navnet på parameteren.
value	string	Tekstværdien.

ConnectionDetailsTimeParameter

Object

ConnectionDetailsParameter for time dataType.

Name	Type	Beskrivelse
dataType	string: Time	Parameterens datatype.
name	string	Navnet på parameteren.
value	string (time)	Klokkeslætsværdien ved hjælp af HH:mm:ss. FFFZ-format.

ConnectionEncryption

Optælling

Forbindelseskrypteringstypen for forbindelsen. Der kan tilføjes yderligere krypteringsværdier for forbindelsen over tid.

Værdi	Beskrivelse
Encrypted	Forbindelsesforsøget foretages ved hjælp af en krypteret forbindelse.
Any	Forbindelsesforsøget foretages først ved hjælp af en krypteret forbindelse og går derefter tilbage til ukrypteret forbindelse, hvis det mislykkes.
NotEncrypted	Forbindelsesforsøget udføres ved hjælp af en ukrypteret forbindelse.

ConnectivityType

Optælling

Forbindelsestypen for forbindelsen. Der kan tilføjes flere forbindelsestyper over tid.

Værdi	Beskrivelse
ShareableCloud	Forbindelsen opretter forbindelse via cloudmiljøet og kan deles med andre.
PersonalCloud	Forbindelsen opretter forbindelse via cloudmiljøet og kan ikke deles med andre.
OnPremisesGateway	Forbindelsen opretter forbindelse via en datagateway i det lokale miljø.
OnPremisesGatewayPersonal	Forbindelsen opretter forbindelse via en personlig datagateway i det lokale miljø.
VirtualNetworkGateway	Forbindelsen opretter forbindelse via en virtuel netværksdatagateway.
Automatic	Forbindelsen opretter forbindelse via cloudmiljøet ved hjælp af en implicit dataforbindelse. Denne indstilling er kun tilgængelig for bestemte scenarier, f.eks. semantiske modeller, der bruger Enkelt Sign-On (SSO)."
None	Forbindelsen er ikke bundet

CreateCloudConnectionRequest

Object

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
connectionDetails	CreateConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: ShareableCloud	Forbindelsestypen for forbindelsen.
credentialDetails	CreateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel	PrivacyLevel	(Valgfrit) Niveauet for beskyttelse af personlige oplysninger for forbindelsen. Når der ikke overføres en værdi, angives den til 'Organisations'.

CreateConnectionDetails

Object

Inputtet for forbindelsesoplysninger for oprettelseshandlinger.

Name	Type	Beskrivelse
creationMethod	string	Den oprettelsesmetode, der bruges til at oprette forbindelsen. Du kan se en liste over oprettelsesmetoder ved hjælp af ListSupportedConnectionTypes-API'en .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Listen over forbindelsesparametre. Du kan se en liste over parametre for hver oprettelsesmetode ved hjælp af ListSupportedConnectionTypes-API'en .
type	string	Forbindelsestypen.

CreateCredentialDetails

Object

Inputtet med legitimationsoplysninger til oprettelse af en forbindelse.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	(Valgfrit) Den indstilling for forbindelseskryptering, der bruges under testforbindelsen. Når der ikke overføres nogen værdi, krypteres forbindelsen ikke.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Legitimationsoplysningerne for forbindelsen.
singleSignOnType	SingleSignOnType	(Valgfrit) Forbindelsestypen enkeltlogon. Når der ikke overføres nogen værdi, bruger forbindelsen ikke enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over. Når der ikke overføres en værdi, angives den til 'False'.

CreateOnPremisesConnectionRequest

Object

Name	Type	Beskrivelse
connectionDetails	CreateConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: OnPremisesGateway	Forbindelsestypen for forbindelsen.
credentialDetails	CreateOnPremisesCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
gatewayId	string (uuid)	Objekt-id'et for den primære gateway for gatewayen i det lokale miljø, som forbindelsen er oprettet under.
privacyLevel	PrivacyLevel	(Valgfrit) Niveauet for beskyttelse af personlige oplysninger for forbindelsen. Når der ikke overføres en værdi, angives den til 'Organisations'.

CreateOnPremisesCredentialDetails

Object

Inputtet med legitimationsoplysninger til oprettelse af en gatewayforbindelse i det lokale miljø.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	(Valgfrit) Den indstilling for forbindelseskryptering, der bruges under testforbindelsen. Når der ikke overføres nogen værdi, krypteres forbindelsen ikke.
credentials	OnPremisesGatewayCredentials	Legitimationsoplysningerne for forbindelsen.
singleSignOnType	SingleSignOnType	(Valgfrit) Forbindelsestypen enkeltlogon. Når der ikke overføres nogen værdi, bruger forbindelsen ikke enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over. Når der ikke overføres en værdi, angives den til 'False'.

CreateVirtualNetworkGatewayConnectionRequest

Object

Name	Type	Beskrivelse
connectionDetails	CreateConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: VirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	CreateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
gatewayId	string (uuid)	Objekt-id'et for den virtuelle netværksgateway, som forbindelsen oprettes under.
privacyLevel	PrivacyLevel	(Valgfrit) Niveauet for beskyttelse af personlige oplysninger for forbindelsen. Når der ikke overføres en værdi, angives den til 'Organisations'.

CredentialType

Optælling

Legitimationstypen for forbindelsen. Der kan tilføjes flere typer legitimationsoplysninger over tid.

Værdi	Beskrivelse
Windows	Forbindelsen bruger Windows-godkendelse til at oprette forbindelse. Understøttes kun for gateways i det lokale miljø.
Anonymous	Forbindelsen bruger anonym godkendelse til at oprette forbindelse.
Basic	Forbindelse bruger basisgodkendelse til at oprette forbindelse.
Key	Forbindelse bruger nøglegodkendelse til at oprette forbindelse.
OAuth2	Forbindelsen bruger OAuth 2.0-godkendelse til at oprette forbindelse.
WindowsWithoutImpersonation	Forbindelse bruger Windows-godkendelse (uden mulighed for repræsentation) til at oprette forbindelse. Understøttes kun for gateways i det lokale miljø (personlig tilstand).
SharedAccessSignature	Forbindelse bruger SAS-godkendelse (Shared Access Signature) til at oprette forbindelse.
ServicePrincipal	Forbindelse bruger godkendelse af tjenesteprincipal til at oprette forbindelse.
WorkspaceIdentity	Forbindelse bruger identitetsgodkendelse for arbejdsområdet til at oprette forbindelse.

DataType

Optælling

Datatypen for parameterværdien for oprettelse af forbindelse. Der kan tilføjes flere datatypeværdier over tid.

Værdi	Beskrivelse
Text	Brug tekst som parameterinputværdi.
Number	Brug tal som parameterinputværdi (heltal eller flydende tal).
Boolean	Brug boolesk som parameterinputværdi. False – værdien er false, True – værdien er true.
Duration	Brug varighed som parameterinputværdi ved hjælp af formatet [-]P(n)DT(n)H(n)M(n)S. For eksempel: P3DT4H30M10S (i 3 dage, 4 timer, 30 minutter og 10 sekunder).
Date	Brug dato som parameterinputværdi ved hjælp af formatet YYYY-MM-DD.
DateTime	Brug dato/klokkeslæt som parameterinputværdi ved hjælp af ÅÅÅÅ-MM-DDTHH:mm:ss. FFFZ-format.
DateTimeZone	Brug datotidszonen som parameterinputværdi ved hjælp af ÅÅÅÅ-MM-DDTHH:mm:ss. FFF±hh:mm-format.
Time	Brug tid som parameterinputværdi ved hjælp af TT:mm:ss. FFFZ-format.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

KeyCredentials

Object

Legitimationsoplysninger for NøglelegitimationsoplysningerType.

Name	Type	Beskrivelse
credentialType	string: Key	Legitimationstypen for forbindelsen.
key	string	Nøglen.

ListConnectionDetails

Object

Outputtet med forbindelsesoplysninger for listehandlinger.

Name	Type	Beskrivelse
path	string	Stien til forbindelsen.
type	string	Forbindelsestypen.

ListCredentialDetails

Object

De legitimationsoplysninger, der returneres, når der hentes en forbindelse.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Den indstilling for forbindelseskryptering, der bruges under testforbindelsen.
credentialType	CredentialType	Legitimationstypen for forbindelsen.
singleSignOnType	SingleSignOnType	Forbindelsestypen enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over.

OnPremisesCredentialEntry

Object

Et gateway-id og dets krypterede serialiserede legitimationsoplysninger.

Name	Type	Beskrivelse
encryptedCredentials	string	Den krypterede serialiserede .json af listen over navneværdipar. Navn er et navn på legitimationsoplysninger, og værdien er en værdi for legitimationsoplysninger. Kryptering udføres ved hjælp af RSA-krypteringsalgoritmen (Rivest-Shamir-Adleman) med gatewaymedlemmets offentlige nøgle i det lokale miljø.
gatewayId	string (uuid)	Objekt-id'et for gatewayen.

OnPremisesGatewayConnection

Object

En forbindelse, der opretter forbindelse via datagatewayen i det lokale miljø.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: OnPremisesGateway	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Gatewayobjekt-id'et for forbindelsen.
id	string (uuid)	Objekt-id'et for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

OnPremisesGatewayCredentials

Object

Legitimationsoplysninger til godkendelse via en gateway i det lokale miljø.

Name	Type	Beskrivelse
credentialType	CredentialType	Legitimationstypen for forbindelsen.
values	OnPremisesCredentialEntry[]	Nyttedata for legitimationsoplysninger, der skal sendes til gatewayen i det lokale miljø.

OnPremisesGatewayPersonalConnection

Object

En forbindelse, der opretter forbindelse via en personlig datagateway i det lokale miljø.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: OnPremisesGatewayPersonal	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Gatewayobjekt-id'et for forbindelsen.
id	string (uuid)	Objekt-id'et for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

PersonalCloudConnection

Object

En forbindelse, der opretter forbindelse via cloudmiljøet og ikke kan deles.

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: PersonalCloud	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
id	string (uuid)	Objekt-id'et for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

PrivacyLevel

Optælling

Indstillingen for niveauet for beskyttelse af personlige oplysninger for forbindelsen. Der kan tilføjes yderligere niveauer for beskyttelse af personlige oplysninger over tid.

Værdi	Beskrivelse
None	Der er ikke konfigureret nogen indstilling for niveau for beskyttelse af personlige oplysninger.
Private	Forbindelser, der er angivet til private, indeholder følsomme eller fortrolige oplysninger. Synlighed kan begrænses til godkendte brugere. Data fra en privat forbindelse foldes ikke ind til andre forbindelser, herunder andre private forbindelser.
Organizational	Forbindelser, der er angivet til organisationsforbindelser, kan foldes ind på private og andre organisationsforbindelser. De kan ikke foldes ind til offentlige forbindelser. Synlighed er angivet til en gruppe, der er tillid til.
Public	Filer, internetforbindelser og projektmappedata kan angives til offentlige. Data kan foldes ind til andre forbindelser. Synlighed er tilgængelig for alle.

ServicePrincipalCredentials

Object

Legitimationsoplysninger for ServicePrincipal CredentialType.

Name	Type	Beskrivelse
credentialType	string: ServicePrincipal	Legitimationstypen for forbindelsen.
servicePrincipalClientId	string (uuid)	Klient-id'et for tjenesteprincipalen.
servicePrincipalSecret	string	Hemmeligheden bag tjenesteprincipalen.
tenantId	string (uuid)	Lejer-id'et for tjenesteprincipalen.

ShareableCloudConnection

Object

En forbindelse, der opretter forbindelse via cloudmiljøet.

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: ShareableCloud	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
id	string (uuid)	Objekt-id'et for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

SharedAccessSignatureCredentials

Object

Legitimationsoplysninger for SharedAccessSignature CredentialType.

Name	Type	Beskrivelse
credentialType	string: SharedAccessSignature	Legitimationstypen for forbindelsen.
token	string	Tokenet.

SingleSignOnType

Optælling

Forbindelsestypen enkeltlogon. Der kan tilføjes flere enkeltlogontyper over tid.

Værdi	Beskrivelse
None	Forbindelsen bruger ikke enkeltlogon til at oprette forbindelse.
Kerberos	Forbindelse bruger Kerberos-enkeltlogon til at oprette forbindelse.
MicrosoftEntraID	Forbindelse bruger Enkeltlogon til Microsoft Entra-id til at oprette forbindelse.
SecurityAssertionMarkupLanguage	Forbindelse bruger SAML -enkeltlogon (Security Assertion Markup Language) til at oprette forbindelse.
KerberosDirectQueryAndRefresh	Forbindelse bruger Kerberos DirectQuery og Opdater enkeltlogon til at oprette forbindelse.

VirtualNetworkGatewayConnection

Object

En forbindelse, der opretter forbindelse via en virtuel netværksdatagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectivityType	string: VirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Gatewayobjekt-id'et for forbindelsen.
id	string (uuid)	Objekt-id'et for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

WindowsCredentials

Object

Legitimationsoplysninger for Windows CredentialType.

Name	Type	Beskrivelse
credentialType	string: Windows	Legitimationstypen for forbindelsen.
password	string	Adgangskoden.
username	string	Brugernavnet.

WindowsWithoutImpersonationCredentials

Object

Legitimationsoplysninger for WindowsWithoutImpersonation CredentialType.

Name	Type	Beskrivelse
credentialType	string: WindowsWithoutImpersonation	Legitimationstypen for forbindelsen.

WorkspaceIdentityCredentials

Object

Legitimationsoplysninger for WorkspaceIdentity CredentialType.

Name	Type	Beskrivelse
credentialType	string: WorkspaceIdentity	Legitimationstypen for forbindelsen.

Del via

Connections - Create Connection

Permissions

Påkrævede delegerede områder

Microsoft Entra-understøttede identiteter

Interface

Brødtekst for anmodning

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Svar

Eksempler

Cloud example

Eksempelanmodning

Eksempelsvar

On-premises gateway example

Eksempelanmodning

Eksempelsvar

Virtual network gateway example

Eksempelanmodning

Eksempelsvar

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