Connections - Create Connection

Tjeneste:

Core

API-versjon:

v1

Oppretter en tilkobling.
Hvis du vil kryptere legitimasjon, kan du se Konfigurere legitimasjon programmatisk.

Permissions

• Hvis du oppretter en gateway-tilkobling, må innringeren ha tillatelser for gatewayen..
• Tjenestekontohavere må ha tillatelse gitt av Fabric-administrator. Hvis du vil ha mer informasjon, kan du se: Tjenestekontohavere kan opprette arbeidsområder, tilkoblinger og utrullingssamlebånd.

Nødvendige delegerte omfang

Connection.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity	Support
User	Yes
tjenestekontohaver og administrerte identiteter	Yes

Interface

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

Brødtekst for forespørsel

Forespørselsteksten kan være ett av følgende:

Navn	Beskrivelse
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Navn	Obligatorisk	Type	Beskrivelse
connectionDetails	True	CreateConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	True	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	True	CreateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	True	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
allowConnectionUsageInGateway		boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
privacyLevel		PrivacyLevel	(Valgfritt) Personvernnivået for tilkoblingen. Når ingen verdi sendes, settes dette til Organisasjonsorganisasjon.

CreateOnPremisesConnectionRequest

Navn	Obligatorisk	Type	Beskrivelse
connectionDetails	True	CreateConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	True	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	True	CreateOnPremisesCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	True	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
gatewayId	True	string (uuid)	Objekt-ID-en for den primære gatewayen for den lokale gatewayen som tilkoblingen er opprettet under.
privacyLevel		PrivacyLevel	(Valgfritt) Personvernnivået for tilkoblingen. Når ingen verdi sendes, settes dette til Organisasjonsorganisasjon.

CreateVirtualNetworkGatewayConnectionRequest

Navn	Obligatorisk	Type	Beskrivelse
connectionDetails	True	CreateConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	True	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	True	CreateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	True	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
gatewayId	True	string (uuid)	Objekt-ID-en for den virtuelle nettverksgatewayen som tilkoblingen er opprettet under.
privacyLevel		PrivacyLevel	(Valgfritt) Personvernnivået for tilkoblingen. Når ingen verdi sendes, settes dette til Organisasjonsorganisasjon.

Svar

Navn	Type	Beskrivelse
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Operasjonen var vellykket.
Other Status Codes	ErrorResponse	Vanlige feilkoder: DuplicateConnectionName – tilkoblingsnavnet er allerede i bruk. InvalidConnectionDetails – Angitte ConnectionDetails-inndata er ikke gyldige. InvalidCredentialDetails – Angitte CredentialDetails-inndata er ikke gyldige. IncorrectCredentials – Kan ikke opprette tilkobling ved hjelp av legitimasjonsinndata. CreateGatewayConnectionFailed – Kan ikke opprette gateway-tilkobling.

Eksempler

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Eksempelforespørsel

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

Eksempelforespørsel

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

Eksempelforespørsel

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

Definisjoner

Navn	Beskrivelse
AnonymousCredentials	Legitimasjon for anonym legitimasjonstype.
BasicCredentials	Legitimasjon for grunnleggende legitimasjonstype.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter for boolsk dataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter for date dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter for dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter for dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter for duration dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter for number dataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter for text dataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter for time dataType.
ConnectionEncryption	Tilkoblingskrypteringstypen for tilkoblingen. Flere tilkoblingskrypteringsverdier kan legges til over tid.
ConnectivityType	Tilkoblingstypen for tilkoblingen. Flere tilkoblingstyper kan legges til over tid.
CreateCloudConnectionRequest
CreateConnectionDetails	Inndata for tilkoblingsdetaljer for oppretting av operasjoner.
CreateCredentialDetails	Inndata for legitimasjonsdetaljer for å opprette en tilkobling.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Inndata for legitimasjonsdetaljer for oppretting av en lokal gatewaytilkobling.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Legitimasjonstypen for tilkoblingen. Flere legitimasjonstyper kan legges til over tid.
DataType	Datatypen for parameterverdien for tilkoblingsoppretting. Flere datatypeverdier kan legges til over tid.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
KeyCredentials	Legitimasjon for Key CredentialType.
ListConnectionDetails	Utdata for tilkoblingsdetaljer for listeoperasjoner.
ListCredentialDetails	Legitimasjonsdetaljene som returneres når du henter en tilkobling.
OnPremisesCredentialEntry	En gateway-ID og den krypterte serialiserte legitimasjonen.
OnPremisesGatewayConnection	En tilkobling som kobles til via lokal datagateway.
OnPremisesGatewayCredentials	Legitimasjon for godkjenning gjennom en lokal gateway.
OnPremisesGatewayPersonalConnection	En tilkobling som kobles til via en personlig lokal datagateway.
PersonalCloudConnection	En tilkobling som kobles til via skyen og ikke kan deles.
PrivacyLevel	Innstillingen for personvernnivå for tilkoblingen. Flere personvernnivåer kan legges til over tid.
ServicePrincipalCredentials	Legitimasjon for ServicePrincipal CredentialType.
ShareableCloudConnection	En tilkobling som kobles til via skyen.
SharedAccessSignatureCredentials	Legitimasjon for SharedAccessSignature CredentialType.
SingleSignOnType	Enkel påloggingstype for tilkoblingen. Flere typer enkel pålogging kan legges til over tid.
VirtualNetworkGatewayConnection	En tilkobling som kobles til via en virtuell nettverksdatagateway.
WindowsCredentials	Legitimasjon for Windows CredentialType.
WindowsWithoutImpersonationCredentials	Legitimasjon for WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Legitimasjon for CredentialType for WorkspaceIdentity.

AnonymousCredentials

Object

Legitimasjon for anonym legitimasjonstype.

Navn	Type	Beskrivelse
credentialType	string: Anonymous	Legitimasjonstypen for tilkoblingen.

BasicCredentials

Object

Legitimasjon for grunnleggende legitimasjonstype.

Navn	Type	Beskrivelse
credentialType	string: Basic	Legitimasjonstypen for tilkoblingen.
password	string	Passordet.
username	string	Brukernavnet.

ConnectionDetailsBooleanParameter

Object

ConnectionDetailsParameter for boolsk dataType.

Navn	Type	Beskrivelse
dataType	string: Boolean	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	boolean	Den boolske verdien.

ConnectionDetailsDateParameter

Object

ConnectionDetailsParameter for date dataType.

Navn	Type	Beskrivelse
dataType	string: Date	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	string (date)	Datoverdien ved hjelp av YYYY-MM-DD format.

ConnectionDetailsDateTimeParameter

Object

ConnectionDetailsParameter for dateTime dataType.

Navn	Type	Beskrivelse
dataType	string: DateTime	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	string (date-time)	Datotidsverdien ved hjelp av ÅÅÅÅÅ-MM-DDTHH:mm:ss. FFFZ-format.

ConnectionDetailsDateTimeZoneParameter

Object

ConnectionDetailsParameter for dateTimeZone dataType.

Navn	Type	Beskrivelse
dataType	string: DateTimeZone	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	string (date-time-offset)	Datotidssoneverdien ved hjelp av ÅÅÅÅÅ-MM-DDTHH:mm:ss. FFF±hh:mm-format.

ConnectionDetailsDurationParameter

Object

ConnectionDetailsParameter for duration dataType.

Navn	Type	Beskrivelse
dataType	string: Duration	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	string (time-span)	Varighetsverdien ved hjelp av [-]P(n)DT(n)H(n)M(n)S-format. Eksempel: P3DT4H30M10S (for 3 dager, 4 timer, 30 minutter og 10 sekunder).

ConnectionDetailsNumberParameter

Object

ConnectionDetailsParameter for number dataType.

Navn	Type	Beskrivelse
dataType	string: Number	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	number	Tallverdien.

ConnectionDetailsTextParameter

Object

ConnectionDetailsParameter for text dataType.

Navn	Type	Beskrivelse
dataType	string: Text	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	string	Tekstverdien.

ConnectionDetailsTimeParameter

Object

ConnectionDetailsParameter for time dataType.

Navn	Type	Beskrivelse
dataType	string: Time	Datatypen for parameteren.
name	string	Navnet på parameteren.
value	string (time)	Tidsverdien ved hjelp av HH:mm:ss. FFFZ-format.

ConnectionEncryption

Opplisting

Tilkoblingskrypteringstypen for tilkoblingen. Flere tilkoblingskrypteringsverdier kan legges til over tid.

Verdi	Beskrivelse
Encrypted	Tilkoblingsforsøket utføres ved hjelp av en kryptert tilkobling.
Any	Tilkoblingsforsøket utføres først ved hjelp av en kryptert tilkobling, og faller deretter tilbake til ukryptert tilkobling hvis den ikke lykkes.
NotEncrypted	Tilkoblingsforsøket utføres ved hjelp av en ukryptert tilkobling.

ConnectivityType

Opplisting

Tilkoblingstypen for tilkoblingen. Flere tilkoblingstyper kan legges til over tid.

Verdi	Beskrivelse
ShareableCloud	Tilkoblingen kobles til via skyen og kan deles med andre.
PersonalCloud	Tilkoblingen kobles til via skyen og kan ikke deles med andre.
OnPremisesGateway	Tilkoblingen kobles til via en lokal datagateway.
OnPremisesGatewayPersonal	Tilkoblingen kobles til via en personlig lokal datagateway.
VirtualNetworkGateway	Tilkoblingen kobles til via en virtuell nettverksdatagateway.
Automatic	Tilkoblingen kobles til via skyen ved hjelp av en implisitt datatilkobling. Dette alternativet er bare tilgjengelig for bestemte scenarioer som semantiske modeller som bruker enkel Sign-On (SSO)."
None	Tilkoblingen er ikke bundet

CreateCloudConnectionRequest

Object

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectionDetails	CreateConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	CreateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel	PrivacyLevel	(Valgfritt) Personvernnivået for tilkoblingen. Når ingen verdi sendes, settes dette til Organisasjonsorganisasjon.

CreateConnectionDetails

Object

Inndata for tilkoblingsdetaljer for oppretting av operasjoner.

Navn	Type	Beskrivelse
creationMethod	string	Opprettingsmetoden som brukes til å opprette tilkoblingen. For en liste over opprettelsesmetoder bruker du API-en ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Listen over tilkoblingsparametere. For en liste over parametere for hver opprettelsesmetode bruker du API-en ListSupportedConnectionTypes .
type	string	Tilkoblingstypen.

CreateCredentialDetails

Object

Inndata for legitimasjonsdetaljer for å opprette en tilkobling.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	(Valgfritt) Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen. Når ingen verdi sendes, krypteres ikke tilkoblingen.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Legitimasjonen for tilkoblingen.
singleSignOnType	SingleSignOnType	(Valgfritt) Enkel påloggingstype for tilkoblingen. Når ingen verdi sendes, bruker ikke tilkoblingen enkel pålogging.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen. Når ingen verdi sendes, settes dette til Usann.

CreateOnPremisesConnectionRequest

Object

Navn	Type	Beskrivelse
connectionDetails	CreateConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	CreateOnPremisesCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
gatewayId	string (uuid)	Objekt-ID-en for den primære gatewayen for den lokale gatewayen som tilkoblingen er opprettet under.
privacyLevel	PrivacyLevel	(Valgfritt) Personvernnivået for tilkoblingen. Når ingen verdi sendes, settes dette til Organisasjonsorganisasjon.

CreateOnPremisesCredentialDetails

Object

Inndata for legitimasjonsdetaljer for oppretting av en lokal gatewaytilkobling.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	(Valgfritt) Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen. Når ingen verdi sendes, krypteres ikke tilkoblingen.
credentials	OnPremisesGatewayCredentials	Legitimasjonen for tilkoblingen.
singleSignOnType	SingleSignOnType	(Valgfritt) Enkel påloggingstype for tilkoblingen. Når ingen verdi sendes, bruker ikke tilkoblingen enkel pålogging.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen. Når ingen verdi sendes, settes dette til Usann.

CreateVirtualNetworkGatewayConnectionRequest

Object

Navn	Type	Beskrivelse
connectionDetails	CreateConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	CreateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
gatewayId	string (uuid)	Objekt-ID-en for den virtuelle nettverksgatewayen som tilkoblingen er opprettet under.
privacyLevel	PrivacyLevel	(Valgfritt) Personvernnivået for tilkoblingen. Når ingen verdi sendes, settes dette til Organisasjonsorganisasjon.

CredentialType

Opplisting

Legitimasjonstypen for tilkoblingen. Flere legitimasjonstyper kan legges til over tid.

Verdi	Beskrivelse
Windows	Tilkobling bruker Windows-godkjenning til å koble til. Støttes bare for lokale gatewayer.
Anonymous	Tilkobling bruker anonym godkjenning til å koble til.
Basic	Tilkobling bruker enkel godkjenning til å koble til.
Key	Tilkobling bruker nøkkelgodkjenning til å koble til.
OAuth2	Tilkobling bruker OAuth 2.0-godkjenning til å koble til.
WindowsWithoutImpersonation	Tilkobling bruker Windows -godkjenning (uten mulighet for representasjon) til å koble til. Støttes bare for lokale gatewayer (personlig modus).
SharedAccessSignature	Tilkobling bruker SAS-godkjenning (shared access signature) til å koble til.
ServicePrincipal	Tilkobling bruker tjenestekontohavergodkjenning til å koble til.
WorkspaceIdentity	Tilkobling bruker godkjenning av arbeidsområdeidentitet til å koble til.

DataType

Opplisting

Datatypen for parameterverdien for tilkoblingsoppretting. Flere datatypeverdier kan legges til over tid.

Verdi	Beskrivelse
Text	Bruk tekst som inndataverdi for parameter.
Number	Bruk tall som inndataverdi for parameter (heltall eller flytende punkt).
Boolean	Bruk boolsk som inndataverdi for parameter. Usann – verdien er usann, Sann – verdien er sann.
Duration	Bruk varighet som inndataverdi for parameter ved hjelp av [-]P(n)DT(n)H(n)M(n)S-format. Eksempel: P3DT4H30M10S (for 3 dager, 4 timer, 30 minutter og 10 sekunder).
Date	Bruk dato som inndataverdi for parameter ved hjelp av YYYY-MM-DD-format.
DateTime	Bruk datotidspunkt som inndataverdi for parameteren ved hjelp av ÅÅÅÅÅ-MM-DDTHH:mm:ss. FFFZ-format.
DateTimeZone	Bruk datotidssone som inndataverdi for parameter ved hjelp av ÅÅÅÅÅ-MM-DDTHH:mm:ss. FFF±hh:mm-format.
Time	Bruk tid som inndataverdi for parameter ved hjelp av HH:mm:ss. FFFZ-format.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

KeyCredentials

Object

Legitimasjon for Key CredentialType.

Navn	Type	Beskrivelse
credentialType	string: Key	Legitimasjonstypen for tilkoblingen.
key	string	Nøkkelen.

ListConnectionDetails

Object

Utdata for tilkoblingsdetaljer for listeoperasjoner.

Navn	Type	Beskrivelse
path	string	Banen til tilkoblingen.
type	string	Tilkoblingstypen.

ListCredentialDetails

Object

Legitimasjonsdetaljene som returneres når du henter en tilkobling.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen.
credentialType	CredentialType	Legitimasjonstypen for tilkoblingen.
singleSignOnType	SingleSignOnType	Enkel påloggingstype for tilkoblingen.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen.

OnPremisesCredentialEntry

Object

En gateway-ID og den krypterte serialiserte legitimasjonen.

Navn	Type	Beskrivelse
encryptedCredentials	string	Den krypterte serialiserte .json av listen over navneverdipar. Navnet er et legitimasjonsnavn, og verdien er en legitimasjonsverdi. Kryptering utføres ved hjelp av krypteringsalgoritmen Rivest-Shamir-Adleman (RSA) med den lokale gateway-medlemmets offentlige nøkkel.
gatewayId	string (uuid)	Objekt-ID-en for gatewayen.

OnPremisesGatewayConnection

Object

En tilkobling som kobles til via lokal datagateway.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

OnPremisesGatewayCredentials

Object

Legitimasjon for godkjenning gjennom en lokal gateway.

Navn	Type	Beskrivelse
credentialType	CredentialType	Legitimasjonstypen for tilkoblingen.
values	OnPremisesCredentialEntry[]	Nyttelasten for legitimasjon som skal sendes til den lokale gatewayen.

OnPremisesGatewayPersonalConnection

Object

En tilkobling som kobles til via en personlig lokal datagateway.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: OnPremisesGatewayPersonal	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

PersonalCloudConnection

Object

En tilkobling som kobles til via skyen og ikke kan deles.

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: PersonalCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

PrivacyLevel

Opplisting

Innstillingen for personvernnivå for tilkoblingen. Flere personvernnivåer kan legges til over tid.

Verdi	Beskrivelse
None	Ingen innstilling for personvernnivå er konfigurert.
Private	Tilkoblinger som er satt til privat, inneholder sensitiv eller konfidensiell informasjon. Synlighet kan begrenses til autoriserte brukere. Data fra en privat tilkobling vil ikke foldes inn i andre tilkoblinger, inkludert andre private tilkoblinger.
Organizational	Tilkoblinger som er satt til organisatoriske, kan foldes inn i private og andre organisatoriske tilkoblinger. De kan ikke kaste seg inn i offentlige tilkoblinger. Synlighet er satt til en klarert gruppe.
Public	Filer, Internett-tilkoblinger og arbeidsbokdata kan settes til offentlig. Data kan brettes inn i andre tilkoblinger. Synlighet er tilgjengelig for alle.

ServicePrincipalCredentials

Object

Legitimasjon for ServicePrincipal CredentialType.

Navn	Type	Beskrivelse
credentialType	string: ServicePrincipal	Legitimasjonstypen for tilkoblingen.
servicePrincipalClientId	string (uuid)	Klient-ID-en til tjenestekontohaveren.
servicePrincipalSecret	string	Hemmeligheten bak tjenestekontohaveren.
tenantId	string (uuid)	Leier-ID-en til tjenestekontohaveren.

ShareableCloudConnection

Object

En tilkobling som kobles til via skyen.

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

SharedAccessSignatureCredentials

Object

Legitimasjon for SharedAccessSignature CredentialType.

Navn	Type	Beskrivelse
credentialType	string: SharedAccessSignature	Legitimasjonstypen for tilkoblingen.
token	string	Tokenet.

SingleSignOnType

Opplisting

Enkel påloggingstype for tilkoblingen. Flere typer enkel pålogging kan legges til over tid.

Verdi	Beskrivelse
None	Tilkoblingen bruker ikke enkel pålogging for å koble til.
Kerberos	Tilkobling bruker Kerberos enkel pålogging til å koble til.
MicrosoftEntraID	Tilkobling bruker enkel pålogging for Microsoft Entra ID til å koble til.
SecurityAssertionMarkupLanguage	Tilkobling bruker SAML (Security Assertion Markup Language) enkel pålogging for å koble til.
KerberosDirectQueryAndRefresh	Tilkobling bruker Kerberos DirectQuery og Oppdater enkel pålogging for å koble til.

VirtualNetworkGatewayConnection

Object

En tilkobling som kobles til via en virtuell nettverksdatagateway.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectivityType	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

WindowsCredentials

Object

Legitimasjon for Windows CredentialType.

Navn	Type	Beskrivelse
credentialType	string: Windows	Legitimasjonstypen for tilkoblingen.
password	string	Passordet.
username	string	Brukernavnet.

WindowsWithoutImpersonationCredentials

Object

Legitimasjon for WindowsWithoutImpersonation CredentialType.

Navn	Type	Beskrivelse
credentialType	string: WindowsWithoutImpersonation	Legitimasjonstypen for tilkoblingen.

WorkspaceIdentityCredentials

Object

Legitimasjon for CredentialType for WorkspaceIdentity.

Navn	Type	Beskrivelse
credentialType	string: WorkspaceIdentity	Legitimasjonstypen for tilkoblingen.