Delen via

Connections - Create Connection

Service:
Core
API-versie:
v1

Hiermee maakt u een verbinding.
Zie Referenties programmatisch configurerenom referenties te versleutelen.

Permissions

Vereiste gedelegeerde bereiken

Connection.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identity Support
User Yes
service-principal en beheerde identiteiten Yes

Interface

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

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name Vereist Type Description
connectionDetails True

CreateConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType True string:

ShareableCloud

Het verbindingstype van de verbinding.
credentialDetails True

CreateCredentialDetails

De referentiegegevens van de verbinding.
displayName True

string

De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
allowConnectionUsageInGateway

boolean

Sta toe dat deze verbinding wordt gebruikt met on-premises gegevensgateways of VNet-gegevensgateways.
privacyLevel

PrivacyLevel

(Optioneel) Het privacyniveau van de verbinding. Wanneer er geen waarde wordt doorgegeven, is dit ingesteld op 'Organisatie'.

CreateOnPremisesConnectionRequest

Name Vereist Type Description
connectionDetails True

CreateConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType True string:

OnPremisesGateway

Het verbindingstype van de verbinding.
credentialDetails True

CreateOnPremisesCredentialDetails

De referentiegegevens van de verbinding.
displayName True

string

De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
gatewayId True

string (uuid)

De object-id van de primaire gateway van de on-premises gateway waaronder de verbinding wordt gemaakt.
privacyLevel

PrivacyLevel

(Optioneel) Het privacyniveau van de verbinding. Wanneer er geen waarde wordt doorgegeven, is dit ingesteld op 'Organisatie'.

CreateVirtualNetworkGatewayConnectionRequest

Name Vereist Type Description
connectionDetails True

CreateConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType True string:

VirtualNetworkGateway

Het verbindingstype van de verbinding.
credentialDetails True

CreateCredentialDetails

De referentiegegevens van de verbinding.
displayName True

string

De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
gatewayId True

string (uuid)

De object-id van de virtuele netwerkgateway waaronder de verbinding is gemaakt.
privacyLevel

PrivacyLevel

(Optioneel) Het privacyniveau van de verbinding. Wanneer er geen waarde wordt doorgegeven, is dit ingesteld op 'Organisatie'.

Antwoorden

Name Type Description
201 Created Connection:

Created. De bewerking is geslaagd.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • DuplicateConnectionName: de naam van de verbinding is al in gebruik.

  • InvalidConnectionDetails: de opgegeven ConnectionDetails-invoer is ongeldig.

  • InvalidCredentialDetails: de opgegeven CredentialDetails-invoer is ongeldig.

  • IncorrectCredentials : kan geen verbinding tot stand brengen met behulp van de referentiesinvoer.

  • CreateGatewayConnectionFailed : kan geen gatewayverbinding maken.

Voorbeelden

Cloud example
On-premises gateway example
Virtual network gateway example

Cloud example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AnonymousCredentials

Referenties voor Anonymous CredentialType.
BasicCredentials

Referenties voor Basic CredentialType.
ConnectionDetailsBooleanParameter

ConnectionDetailsParameter voor booleaanse dataType.
ConnectionDetailsDateParameter

ConnectionDetailsParameter voor datum dataType.
ConnectionDetailsDateTimeParameter

ConnectionDetailsParameter voor dateTime dataType.
ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsParameter voor dateTimeZone dataType.
ConnectionDetailsDurationParameter

ConnectionDetailsParameter voor duur dataType.
ConnectionDetailsNumberParameter

ConnectionDetailsParameter voor numeriek dataType.
ConnectionDetailsTextParameter

ConnectionDetailsParameter voor tekst dataType.
ConnectionDetailsTimeParameter

ConnectionDetailsParameter voor time dataType.
ConnectionEncryption

Het type verbindingsversleuteling van de verbinding. Er kunnen na verloop van tijd extra verbindingsversleutelingswaarden worden toegevoegd.
ConnectivityType

Het verbindingstype van de verbinding. Er kunnen in de loop van de tijd extra verbindingstypen worden toegevoegd.
CreateCloudConnectionRequest
CreateConnectionDetails

De invoer van de verbindingsgegevens voor het maken van bewerkingen.
CreateCredentialDetails

De invoer van referentiegegevens voor het maken van een verbinding.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails

De referentiegegevensinvoer voor het maken van een on-premises gatewayverbinding.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType

Het referentietype van de verbinding. Er kunnen in de loop van de tijd extra referentietypen worden toegevoegd.
DataType

Het gegevenstype van de parameterwaarde voor het maken van de verbinding. Er kunnen in de loop van de tijd extra gegevenstypewaarden worden toegevoegd.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
KeyCredentials

Referenties voor Key CredentialType.
ListConnectionDetails

De uitvoer van de verbindingsgegevens voor lijstbewerkingen.
ListCredentialDetails

De referentiegegevens die worden geretourneerd bij het ophalen van een verbinding.
OnPremisesCredentialEntry

Een gateway-id en de versleutelde geserialiseerde referenties.
OnPremisesGatewayConnection

Een verbinding die verbinding maakt via een on-premises gegevensgateway.
OnPremisesGatewayCredentials

Referenties voor verificatie via een on-premises gateway.
OnPremisesGatewayPersonalConnection

Een verbinding die verbinding maakt via een persoonlijke on-premises gegevensgateway.
PersonalCloudConnection

Een verbinding die verbinding maakt via de cloud en niet kan worden gedeeld.
PrivacyLevel

De instelling op privacyniveau van de verbinding. Er kunnen na verloop van tijd extra privacyniveaus worden toegevoegd.
ServicePrincipalCredentials

Referenties voor ServicePrincipal CredentialType.
ShareableCloudConnection

Een verbinding die verbinding maakt via de cloud.
SharedAccessSignatureCredentials

Referenties voor SharedAccessSignature CredentialType.
SingleSignOnType

Het type eenmalige aanmelding van de verbinding. Er kunnen in de loop van de tijd extra typen eenmalige aanmelding worden toegevoegd.
VirtualNetworkGatewayConnection

Een verbinding die verbinding maakt via een gegevensgateway van een virtueel netwerk.
WindowsCredentials

Referenties voor Windows CredentialType.
WindowsWithoutImpersonationCredentials

Referenties voor WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials

Referenties voor WorkspaceIdentity CredentialType.

AnonymousCredentials

Object

Referenties voor Anonymous CredentialType.

Name Type Description
credentialType string:

Anonymous

Het referentietype van de verbinding.

BasicCredentials

Object

Referenties voor Basic CredentialType.

Name Type Description
credentialType string:

Basic

Het referentietype van de verbinding.
password

string

Het wachtwoord.
username

string

De gebruikersnaam.

ConnectionDetailsBooleanParameter

Object

ConnectionDetailsParameter voor booleaanse dataType.

Name Type Description
dataType string:

Boolean

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

boolean

De Booleaanse waarde.

ConnectionDetailsDateParameter

Object

ConnectionDetailsParameter voor datum dataType.

Name Type Description
dataType string:

Date

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

string (date)

De datumwaarde met JJJJ-MM-DD notatie.

ConnectionDetailsDateTimeParameter

Object

ConnectionDetailsParameter voor dateTime dataType.

Name Type Description
dataType string:

DateTime

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

string (date-time)

De datum/tijd-waarde met JJJJ-MM-DDTHH:mm:ss. FFFZ-indeling.

ConnectionDetailsDateTimeZoneParameter

Object

ConnectionDetailsParameter voor dateTimeZone dataType.

Name Type Description
dataType string:

DateTimeZone

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

string (date-time-offset)

De datumtijdzonewaarde met JJJJ-MM-DDTHH:mm:ss. FFF±hh:mm formaat.

ConnectionDetailsDurationParameter

Object

ConnectionDetailsParameter voor duur dataType.

Name Type Description
dataType string:

Duration

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

string (time-span)

De duurwaarde met de notatie .P(n)DT(n)H(n)M(n)S. Bijvoorbeeld: P3DT4H30M10S (voor 3 dagen, 4 uur, 30 minuten en 10 seconden).

ConnectionDetailsNumberParameter

Object

ConnectionDetailsParameter voor numeriek dataType.

Name Type Description
dataType string:

Number

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

number

De getalwaarde.

ConnectionDetailsTextParameter

Object

ConnectionDetailsParameter voor tekst dataType.

Name Type Description
dataType string:

Text

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

string

De tekstwaarde.

ConnectionDetailsTimeParameter

Object

ConnectionDetailsParameter voor time dataType.

Name Type Description
dataType string:

Time

Het gegevenstype van de parameter.
name

string

De naam van de parameter.
value

string (time)

De tijdwaarde met HH:mm:ss. FFFZ-indeling.

ConnectionEncryption

Inventarisatie

Het type verbindingsversleuteling van de verbinding. Er kunnen na verloop van tijd extra verbindingsversleutelingswaarden worden toegevoegd.

Waarde Description
Encrypted

De verbindingspoging wordt uitgevoerd met behulp van een versleutelde verbinding.
Any

De verbindingspoging wordt eerst uitgevoerd met behulp van een versleutelde verbinding en valt vervolgens terug op niet-versleutelde verbinding als dit mislukt.
NotEncrypted

De verbindingspoging wordt uitgevoerd met behulp van een niet-versleutelde verbinding.

ConnectivityType

Inventarisatie

Het verbindingstype van de verbinding. Er kunnen in de loop van de tijd extra verbindingstypen worden toegevoegd.

Waarde Description
ShareableCloud

De verbinding maakt verbinding via de cloud en kan worden gedeeld met anderen.
PersonalCloud

De verbinding maakt verbinding via de cloud en kan niet met anderen worden gedeeld.
OnPremisesGateway

De verbinding maakt verbinding via een on-premises gegevensgateway.
OnPremisesGatewayPersonal

De verbinding maakt verbinding via een persoonlijke on-premises gegevensgateway.
VirtualNetworkGateway

De verbinding maakt verbinding via een gegevensgateway van een virtueel netwerk.
Automatic

De verbinding maakt verbinding via de cloud met behulp van een impliciete gegevensverbinding. Deze optie is alleen beschikbaar voor specifieke scenario's, zoals semantische modellen die gebruikmaken van Single Sign-On (SSO)."
None

De verbinding is niet gebonden

CreateCloudConnectionRequest

Object
Name Type Description
allowConnectionUsageInGateway

boolean

Sta toe dat deze verbinding wordt gebruikt met on-premises gegevensgateways of VNet-gegevensgateways.
connectionDetails

CreateConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

ShareableCloud

Het verbindingstype van de verbinding.
credentialDetails

CreateCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel

PrivacyLevel

(Optioneel) Het privacyniveau van de verbinding. Wanneer er geen waarde wordt doorgegeven, is dit ingesteld op 'Organisatie'.

CreateConnectionDetails

Object

De invoer van de verbindingsgegevens voor het maken van bewerkingen.

Name Type Description
creationMethod

string

De methode voor het maken van de verbinding. Voor een lijst met aanmaakmethoden gebruikt u de API ListSupportedConnectionTypes .
parameters ConnectionDetailsParameter[]:

De lijst met verbindingsparameters. Voor een lijst met parameters voor elke aanmaakmethode gebruikt u de API ListSupportedConnectionTypes .
type

string

Het type verbinding.

CreateCredentialDetails

Object

De invoer van referentiegegevens voor het maken van een verbinding.

Name Type Description
connectionEncryption

ConnectionEncryption

(Optioneel) De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding. Wanneer er geen waarde wordt doorgegeven, wordt de verbinding niet versleuteld.
credentials Credentials:

De referenties van de verbinding.
singleSignOnType

SingleSignOnType

(Optioneel) Het type eenmalige aanmelding van de verbinding. Wanneer er geen waarde wordt doorgegeven, gebruikt de verbinding geen eenmalige aanmelding.
skipTestConnection

boolean

Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over. Als er geen waarde wordt doorgegeven, is dit ingesteld op 'False'.

CreateOnPremisesConnectionRequest

Object
Name Type Description
connectionDetails

CreateConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

OnPremisesGateway

Het verbindingstype van de verbinding.
credentialDetails

CreateOnPremisesCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
gatewayId

string (uuid)

De object-id van de primaire gateway van de on-premises gateway waaronder de verbinding wordt gemaakt.
privacyLevel

PrivacyLevel

(Optioneel) Het privacyniveau van de verbinding. Wanneer er geen waarde wordt doorgegeven, is dit ingesteld op 'Organisatie'.

CreateOnPremisesCredentialDetails

Object

De referentiegegevensinvoer voor het maken van een on-premises gatewayverbinding.

Name Type Description
connectionEncryption

ConnectionEncryption

(Optioneel) De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding. Wanneer er geen waarde wordt doorgegeven, wordt de verbinding niet versleuteld.
credentials

OnPremisesGatewayCredentials

De referenties van de verbinding.
singleSignOnType

SingleSignOnType

(Optioneel) Het type eenmalige aanmelding van de verbinding. Wanneer er geen waarde wordt doorgegeven, gebruikt de verbinding geen eenmalige aanmelding.
skipTestConnection

boolean

Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over. Als er geen waarde wordt doorgegeven, is dit ingesteld op 'False'.

CreateVirtualNetworkGatewayConnectionRequest

Object
Name Type Description
connectionDetails

CreateConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

VirtualNetworkGateway

Het verbindingstype van de verbinding.
credentialDetails

CreateCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
gatewayId

string (uuid)

De object-id van de virtuele netwerkgateway waaronder de verbinding is gemaakt.
privacyLevel

PrivacyLevel

(Optioneel) Het privacyniveau van de verbinding. Wanneer er geen waarde wordt doorgegeven, is dit ingesteld op 'Organisatie'.

CredentialType

Inventarisatie

Het referentietype van de verbinding. Er kunnen in de loop van de tijd extra referentietypen worden toegevoegd.

Waarde Description
Windows

Verbinding maakt gebruik van Windows-verificatie om verbinding te maken. Alleen ondersteund voor on-premises gateways.
Anonymous

Verbinding maakt gebruik van anonieme verificatie om verbinding te maken.
Basic

Verbinding maakt gebruik van basisverificatie om verbinding te maken.
Key

Verbinding maakt gebruik van sleutelverificatie om verbinding te maken.
OAuth2

Verbinding maakt gebruik van OAuth 2.0-verificatie om verbinding te maken.
WindowsWithoutImpersonation

Verbinding maakt gebruik van Windows-verificatie (zonder de optie voor imitatie) om verbinding te maken. Alleen ondersteund voor on-premises gateways (persoonlijke modus).
SharedAccessSignature

Verbinding maakt gebruik van SAS-verificatie (Shared Access Signature) om verbinding te maken.
ServicePrincipal

Verbinding maakt gebruik van verificatie van de service-principal om verbinding te maken.
WorkspaceIdentity

Verbinding maakt gebruik van verificatie van werkruimte-id's om verbinding te maken.

DataType

Inventarisatie

Het gegevenstype van de parameterwaarde voor het maken van de verbinding. Er kunnen in de loop van de tijd extra gegevenstypewaarden worden toegevoegd.

Waarde Description
Text

Gebruik tekst als de parameterinvoerwaarde.
Number

Gebruik getal als de parameterinvoerwaarde (geheel getal of drijvende komma).
Boolean

Gebruik Booleaanse waarde als de parameterinvoerwaarde. Onwaar: de waarde is onwaar, Waar. De waarde is waar.
Duration

Gebruik de duur als de parameterinvoerwaarde met behulp van de notatie .P(n)DT(n)H(n)M(n)S. Bijvoorbeeld: P3DT4H30M10S (voor 3 dagen, 4 uur, 30 minuten en 10 seconden).
Date

Gebruik datum als de parameterinvoerwaarde, met JJJJ-MM-DD-indeling.
DateTime

Gebruik datum/tijd als de parameterinvoerwaarde met JJJJ-MM-DDTHH:mm:ss. FFFZ-indeling.
DateTimeZone

Gebruik de datumtijdzone als de parameterinvoerwaarde met JJJJ-MM-DDTHH:mm:ss. FFF±hh:mm formaat.
Time

Gebruik tijd als de parameterinvoerwaarde met HH:mm:ss. FFFZ-indeling.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

KeyCredentials

Object

Referenties voor Key CredentialType.

Name Type Description
credentialType string:

Key

Het referentietype van de verbinding.
key

string

De sleutel.

ListConnectionDetails

Object

De uitvoer van de verbindingsgegevens voor lijstbewerkingen.

Name Type Description
path

string

Het pad van de verbinding.
type

string

Het type verbinding.

ListCredentialDetails

Object

De referentiegegevens die worden geretourneerd bij het ophalen van een verbinding.

Name Type Description
connectionEncryption

ConnectionEncryption

De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding.
credentialType

CredentialType

Het referentietype van de verbinding.
singleSignOnType

SingleSignOnType

Het type eenmalige aanmelding van de verbinding.
skipTestConnection

boolean

Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over.

OnPremisesCredentialEntry

Object

Een gateway-id en de versleutelde geserialiseerde referenties.

Name Type Description
encryptedCredentials

string

De versleutelde geserialiseerde .json van de lijst met naam-waardeparen. De naam is een referentienaam en waarde is een referentiewaarde. Versleuteling wordt uitgevoerd met behulp van het RSA-versleutelingsalgoritme (Rivest-Shamir-Adleman) met de openbare sleutel van het on-premises gatewaylid.
gatewayId

string (uuid)

De object-id van de gateway.

OnPremisesGatewayConnection

Object

Een verbinding die verbinding maakt via een on-premises gegevensgateway.

Name Type Description
connectionDetails

ListConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

OnPremisesGateway

Het verbindingstype van de verbinding.
credentialDetails

ListCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding.
gatewayId

string (uuid)

De gatewayobject-id van de verbinding.
id

string (uuid)

De object-id van de verbinding.
privacyLevel

PrivacyLevel

Het privacyniveau van de verbinding.

OnPremisesGatewayCredentials

Object

Referenties voor verificatie via een on-premises gateway.

Name Type Description
credentialType

CredentialType

Het referentietype van de verbinding.
values

OnPremisesCredentialEntry[]

De nettolading van de referentie die naar de on-premises gateway moet worden verzonden.

OnPremisesGatewayPersonalConnection

Object

Een verbinding die verbinding maakt via een persoonlijke on-premises gegevensgateway.

Name Type Description
connectionDetails

ListConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

OnPremisesGatewayPersonal

Het verbindingstype van de verbinding.
credentialDetails

ListCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding.
gatewayId

string (uuid)

De gatewayobject-id van de verbinding.
id

string (uuid)

De object-id van de verbinding.
privacyLevel

PrivacyLevel

Het privacyniveau van de verbinding.

PersonalCloudConnection

Object

Een verbinding die verbinding maakt via de cloud en niet kan worden gedeeld.

Name Type Description
allowConnectionUsageInGateway

boolean

Sta toe dat deze verbinding wordt gebruikt met on-premises gegevensgateways of VNet-gegevensgateways.
connectionDetails

ListConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

PersonalCloud

Het verbindingstype van de verbinding.
credentialDetails

ListCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding.
id

string (uuid)

De object-id van de verbinding.
privacyLevel

PrivacyLevel

Het privacyniveau van de verbinding.

PrivacyLevel

Inventarisatie

De instelling op privacyniveau van de verbinding. Er kunnen na verloop van tijd extra privacyniveaus worden toegevoegd.

Waarde Description
None

Er is geen instelling voor privacyniveau geconfigureerd.
Private

Verbindingen die zijn ingesteld op privé bevatten gevoelige of vertrouwelijke informatie. Zichtbaarheid kan worden beperkt tot geautoriseerde gebruikers. Gegevens van een privéverbinding worden niet naar andere verbindingen gevouwen, inclusief andere privéverbindingen.
Organizational

Verbindingen die zijn ingesteld op de organisatie, kunnen worden ingevouwen tot privé- en andere organisatieverbindingen. Ze kunnen niet invouwen tot openbare verbindingen. Zichtbaarheid is ingesteld op een vertrouwde groep.
Public

Bestanden, internetverbinding en werkmapgegevens kunnen worden ingesteld op openbaar. Gegevens kunnen worden ingevouwen naar andere verbindingen. Zichtbaarheid is voor iedereen beschikbaar.

ServicePrincipalCredentials

Object

Referenties voor ServicePrincipal CredentialType.

Name Type Description
credentialType string:

ServicePrincipal

Het referentietype van de verbinding.
servicePrincipalClientId

string (uuid)

De client-id van de service-principal.
servicePrincipalSecret

string

Het geheim van de service-principal.
tenantId

string (uuid)

De tenant-id van de service-principal.

ShareableCloudConnection

Object

Een verbinding die verbinding maakt via de cloud.

Name Type Description
allowConnectionUsageInGateway

boolean

Sta toe dat deze verbinding wordt gebruikt met on-premises gegevensgateways of VNet-gegevensgateways.
connectionDetails

ListConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

ShareableCloud

Het verbindingstype van de verbinding.
credentialDetails

ListCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding.
id

string (uuid)

De object-id van de verbinding.
privacyLevel

PrivacyLevel

Het privacyniveau van de verbinding.

SharedAccessSignatureCredentials

Object

Referenties voor SharedAccessSignature CredentialType.

Name Type Description
credentialType string:

SharedAccessSignature

Het referentietype van de verbinding.
token

string

Het token.

SingleSignOnType

Inventarisatie

Het type eenmalige aanmelding van de verbinding. Er kunnen in de loop van de tijd extra typen eenmalige aanmelding worden toegevoegd.

Waarde Description
None

Connection maakt geen gebruik van eenmalige aanmelding om verbinding te maken.
Kerberos

Connection maakt gebruik van eenmalige aanmelding van Kerberos om verbinding te maken.
MicrosoftEntraID

Connection maakt gebruik van eenmalige aanmelding van Microsoft Entra ID om verbinding te maken.
SecurityAssertionMarkupLanguage

Connection maakt gebruik van eenmalige aanmelding van Security Assertion Markup Language (SAML) om verbinding te maken.
KerberosDirectQueryAndRefresh

Connection maakt gebruik van Kerberos DirectQuery en Refresh-eenmalige aanmelding om verbinding te maken.

VirtualNetworkGatewayConnection

Object

Een verbinding die verbinding maakt via een gegevensgateway van een virtueel netwerk.

Name Type Description
connectionDetails

ListConnectionDetails

De verbindingsgegevens van de verbinding.
connectivityType string:

VirtualNetworkGateway

Het verbindingstype van de verbinding.
credentialDetails

ListCredentialDetails

De referentiegegevens van de verbinding.
displayName

string

De weergavenaam van de verbinding.
gatewayId

string (uuid)

De gatewayobject-id van de verbinding.
id

string (uuid)

De object-id van de verbinding.
privacyLevel

PrivacyLevel

Het privacyniveau van de verbinding.

WindowsCredentials

Object

Referenties voor Windows CredentialType.

Name Type Description
credentialType string:

Windows

Het referentietype van de verbinding.
password

string

Het wachtwoord.
username

string

De gebruikersnaam.

WindowsWithoutImpersonationCredentials

Object

Referenties voor WindowsWithoutImpersonation CredentialType.

Name Type Description
credentialType string:

WindowsWithoutImpersonation

Het referentietype van de verbinding.

WorkspaceIdentityCredentials

Object

Referenties voor WorkspaceIdentity CredentialType.

Name Type Description
credentialType string:

WorkspaceIdentity

Het referentietype van de verbinding.