Connections - Create Connection

Servizio:: Core

Versione API:: v1

Crea una connessione.
Per crittografare le credenziali, vedere Configurare le credenziali a livello di codice.

Permissions

Se si crea una connessione gateway, il chiamante deve disporre delle autorizzazioni per il gateway.
Le entità servizio devono disporre dell'autorizzazione concessa dall'amministratore di Infrastruttura. Per altre informazioni, vedere: Le entità servizio possono creare aree di lavoro, connessioni e pipeline di distribuzione.

Ambiti delegati obbligatori

Connection.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity	Support
User	Yes
'entità servizio e identità gestite	Yes

Interface

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

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectionDetails	True	CreateConnectionDetails	Dettagli della connessione.
connectivityType	True	string: ShareableCloud	Tipo di connettività della connessione.
credentialDetails	True	CreateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	True	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
allowConnectionUsageInGateway		boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
privacyLevel		PrivacyLevel	(Facoltativo) Livello di privacy della connessione. Quando non viene passato alcun valore, questo valore viene impostato su 'Organizzativo'.

CreateOnPremisesConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectionDetails	True	CreateConnectionDetails	Dettagli della connessione.
connectivityType	True	string: OnPremisesGateway	Tipo di connettività della connessione.
credentialDetails	True	CreateOnPremisesCredentialDetails	Dettagli delle credenziali della connessione.
displayName	True	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
gatewayId	True	string (uuid)	ID oggetto del gateway primario del gateway locale in cui viene creata la connessione.
privacyLevel		PrivacyLevel	(Facoltativo) Livello di privacy della connessione. Quando non viene passato alcun valore, questo valore viene impostato su 'Organizzativo'.

CreateVirtualNetworkGatewayConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectionDetails	True	CreateConnectionDetails	Dettagli della connessione.
connectivityType	True	string: VirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	True	CreateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	True	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
gatewayId	True	string (uuid)	ID oggetto del gateway di rete virtuale in cui viene creata la connessione.
privacyLevel		PrivacyLevel	(Facoltativo) Livello di privacy della connessione. Quando non viene passato alcun valore, questo valore viene impostato su 'Organizzativo'.

Risposte

Nome	Tipo	Descrizione
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Operazione riuscita.
Other Status Codes	ErrorResponse	Codici di errore comuni: DuplicateConnectionName: il nome della connessione è già in uso. InvalidConnectionDetails: l'input ConnectionDetails specificato non è valido. InvalidCredentialDetails: l'input CredentialDetails specificato non è valido. IncorrectCredentials: non è stato possibile stabilire la connessione usando l'input Credenziali. CreateGatewayConnectionFailed: non è stato possibile creare una connessione gateway.

Nome

Tipo

Descrizione

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. Operazione riuscita.

Other Status Codes

ErrorResponse

Codici di errore comuni:

DuplicateConnectionName: il nome della connessione è già in uso.
InvalidConnectionDetails: l'input ConnectionDetails specificato non è valido.
InvalidCredentialDetails: l'input CredentialDetails specificato non è valido.
IncorrectCredentials: non è stato possibile stabilire la connessione usando l'input Credenziali.
CreateGatewayConnectionFailed: non è stato possibile creare una connessione gateway.

Esempio

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
AnonymousCredentials	Credenziali per CredentialType anonimo.
BasicCredentials	Credenziali per CredentialType di base.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter per dataType booleano.
ConnectionDetailsDateParameter	ConnectionDetailsParameter per date dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter per dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter per dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter per duration dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter per number dataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter per text dataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter per time dataType.
ConnectionEncryption	Tipo di crittografia della connessione. È possibile aggiungere altri valori di crittografia della connessione nel tempo.
ConnectivityType	Tipo di connettività della connessione. È possibile aggiungere altri tipi di connettività nel tempo.
CreateCloudConnectionRequest
CreateConnectionDetails	Input dei dettagli della connessione per le operazioni di creazione.
CreateCredentialDetails	Input dei dettagli delle credenziali per la creazione di una connessione.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Input dei dettagli delle credenziali per la creazione di una connessione gateway locale.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Tipo di credenziale della connessione. È possibile aggiungere altri tipi di credenziali nel corso del tempo.
DataType	Tipo di dati del valore del parametro di creazione della connessione. È possibile aggiungere valori aggiuntivi del tipo di dati nel tempo.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
KeyCredentials	Credenziali per Key CredentialType.
ListConnectionDetails	Output dei dettagli della connessione per le operazioni di elenco.
ListCredentialDetails	I dettagli delle credenziali restituiti durante il recupero di una connessione.
OnPremisesCredentialEntry	ID gateway e credenziali serializzate crittografate.
OnPremisesGatewayConnection	Connessione che si connette tramite il gateway dati locale.
OnPremisesGatewayCredentials	Credenziali per l'autenticazione tramite un gateway locale.
OnPremisesGatewayPersonalConnection	Connessione che si connette tramite un gateway dati locale personale.
PersonalCloudConnection	Connessione che si connette tramite il cloud e non può essere condivisa.
PrivacyLevel	Impostazione del livello di privacy della connessione. È possibile aggiungere livelli di privacy aggiuntivi nel tempo.
ServicePrincipalCredentials	Credenziali per ServicePrincipal CredentialType.
ShareableCloudConnection	Connessione che si connette attraverso il cloud.
SharedAccessSignatureCredentials	Credenziali per SharedAccessSignature CredentialType.
SingleSignOnType	Tipo di accesso Single Sign-On della connessione. È possibile aggiungere altri tipi di accesso Single Sign-On nel tempo.
VirtualNetworkGatewayConnection	Connessione che si connette tramite un gateway dati di rete virtuale.
WindowsCredentials	Credenziali per Windows CredentialType.
WindowsWithoutImpersonationCredentials	Credenziali per WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Credenziali per WorkspaceIdentity CredentialType.

AnonymousCredentials

Object

Credenziali per CredentialType anonimo.

Nome	Tipo	Descrizione
credentialType	string: Anonymous	Tipo di credenziale della connessione.

BasicCredentials

Object

Credenziali per CredentialType di base.

Nome	Tipo	Descrizione
credentialType	string: Basic	Tipo di credenziale della connessione.
password	string	La password.
username	string	Il nome utente.

ConnectionDetailsBooleanParameter

Object

ConnectionDetailsParameter per dataType booleano.

Nome	Tipo	Descrizione
dataType	string: Boolean	Tipo di dati del parametro.
name	string	Nome del parametro.
value	boolean	Valore booleano.

ConnectionDetailsDateParameter

Object

ConnectionDetailsParameter per date dataType.

Nome	Tipo	Descrizione
dataType	string: Date	Tipo di dati del parametro.
name	string	Nome del parametro.
value	string (date)	Valore della data che usa il formato AAAA-MM-DD.

ConnectionDetailsDateTimeParameter

Object

ConnectionDetailsParameter per dateTime dataType.

Nome	Tipo	Descrizione
dataType	string: DateTime	Tipo di dati del parametro.
name	string	Nome del parametro.
value	string (date-time)	Valore di data e ora utilizzando AAAA-MM-GGTHH:mm:ss. Formato FFFZ.

ConnectionDetailsDateTimeZoneParameter

Object

ConnectionDetailsParameter per dateTimeZone dataType.

Nome	Tipo	Descrizione
dataType	string: DateTimeZone	Tipo di dati del parametro.
name	string	Nome del parametro.
value	string (date-time-offset)	Valore del fuso orario di data utilizzando AAAA-MM-GGTHH:mm:ss. Formato FFF±hh:mm.

ConnectionDetailsDurationParameter

Object

ConnectionDetailsParameter per duration dataType.

Nome	Tipo	Descrizione
dataType	string: Duration	Tipo di dati del parametro.
name	string	Nome del parametro.
value	string (time-span)	Valore della durata che usa il formato _P(n)DT(n)H(n)M(n)S. Ad esempio: P3DT4H30M10S (per 3 giorni, 4 ore, 30 minuti e 10 secondi).

ConnectionDetailsNumberParameter

Object

ConnectionDetailsParameter per number dataType.

Nome	Tipo	Descrizione
dataType	string: Number	Tipo di dati del parametro.
name	string	Nome del parametro.
value	number	Valore numerico.

ConnectionDetailsTextParameter

Object

ConnectionDetailsParameter per text dataType.

Nome	Tipo	Descrizione
dataType	string: Text	Tipo di dati del parametro.
name	string	Nome del parametro.
value	string	Valore di testo.

ConnectionDetailsTimeParameter

Object

ConnectionDetailsParameter per time dataType.

Nome	Tipo	Descrizione
dataType	string: Time	Tipo di dati del parametro.
name	string	Nome del parametro.
value	string (time)	Valore dell'ora che usa HH:mm:ss. Formato FFFZ.

ConnectionEncryption

Enumerazione

Tipo di crittografia della connessione. È possibile aggiungere altri valori di crittografia della connessione nel tempo.

Valore	Descrizione
Encrypted	Il tentativo di connessione viene eseguito usando una connessione crittografata.
Any	Il tentativo di connessione viene prima eseguito usando una connessione crittografata, quindi esegue il fallback alla connessione non crittografata se non riesce.
NotEncrypted	Il tentativo di connessione viene eseguito usando una connessione non crittografata.

ConnectivityType

Enumerazione

Tipo di connettività della connessione. È possibile aggiungere altri tipi di connettività nel tempo.

Valore	Descrizione
ShareableCloud	La connessione si connette tramite il cloud e può essere condivisa con altri utenti.
PersonalCloud	La connessione si connette tramite il cloud e non può essere condivisa con altri utenti.
OnPremisesGateway	La connessione si connette tramite un gateway dati locale.
OnPremisesGatewayPersonal	La connessione si connette tramite un gateway dati locale personale.
VirtualNetworkGateway	La connessione si connette tramite un gateway dati di rete virtuale.
Automatic	La connessione si connette tramite il cloud usando una connessione dati implicita. Questa opzione è disponibile solo per scenari specifici, ad esempio modelli semantici che usano Single Sign-On (SSO)."
None	La connessione non è associata

CreateCloudConnectionRequest

Object

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
connectionDetails	CreateConnectionDetails	Dettagli della connessione.
connectivityType	string: ShareableCloud	Tipo di connettività della connessione.
credentialDetails	CreateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel	PrivacyLevel	(Facoltativo) Livello di privacy della connessione. Quando non viene passato alcun valore, questo valore viene impostato su 'Organizzativo'.

CreateConnectionDetails

Object

Input dei dettagli della connessione per le operazioni di creazione.

Nome	Tipo	Descrizione
creationMethod	string	Metodo di creazione utilizzato per creare la connessione. Per un elenco dei metodi di creazione, usare l'API ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Elenco di parametri di connessione. Per un elenco di parametri per ogni metodo di creazione, usare l'API ListSupportedConnectionTypes .
type	string	Tipo di connessione.

CreateCredentialDetails

Object

Input dei dettagli delle credenziali per la creazione di una connessione.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	(Facoltativo) Impostazione di crittografia della connessione utilizzata durante la connessione di test. Quando non viene passato alcun valore, la connessione non viene crittografata.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Credenziali della connessione.
singleSignOnType	SingleSignOnType	(Facoltativo) Tipo di accesso Single Sign-On della connessione. Quando non viene passato alcun valore, la connessione non usa l'accesso Single Sign-On.
skipTestConnection	boolean	Indica se la connessione deve ignorare la connessione di test durante la creazione e l'aggiornamento. True: ignorare la connessione di test, False: non ignorare la connessione di test. Quando non viene passato alcun valore, questo valore viene impostato su 'False'.

CreateOnPremisesConnectionRequest

Object

Nome	Tipo	Descrizione
connectionDetails	CreateConnectionDetails	Dettagli della connessione.
connectivityType	string: OnPremisesGateway	Tipo di connettività della connessione.
credentialDetails	CreateOnPremisesCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
gatewayId	string (uuid)	ID oggetto del gateway primario del gateway locale in cui viene creata la connessione.
privacyLevel	PrivacyLevel	(Facoltativo) Livello di privacy della connessione. Quando non viene passato alcun valore, questo valore viene impostato su 'Organizzativo'.

CreateOnPremisesCredentialDetails

Object

Input dei dettagli delle credenziali per la creazione di una connessione gateway locale.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	(Facoltativo) Impostazione di crittografia della connessione utilizzata durante la connessione di test. Quando non viene passato alcun valore, la connessione non viene crittografata.
credentials	OnPremisesGatewayCredentials	Credenziali della connessione.
singleSignOnType	SingleSignOnType	(Facoltativo) Tipo di accesso Single Sign-On della connessione. Quando non viene passato alcun valore, la connessione non usa l'accesso Single Sign-On.
skipTestConnection	boolean	Indica se la connessione deve ignorare la connessione di test durante la creazione e l'aggiornamento. True: ignorare la connessione di test, False: non ignorare la connessione di test. Quando non viene passato alcun valore, questo valore viene impostato su 'False'.

CreateVirtualNetworkGatewayConnectionRequest

Object

Nome	Tipo	Descrizione
connectionDetails	CreateConnectionDetails	Dettagli della connessione.
connectivityType	string: VirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	CreateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
gatewayId	string (uuid)	ID oggetto del gateway di rete virtuale in cui viene creata la connessione.
privacyLevel	PrivacyLevel	(Facoltativo) Livello di privacy della connessione. Quando non viene passato alcun valore, questo valore viene impostato su 'Organizzativo'.

CredentialType

Enumerazione

Tipo di credenziale della connessione. È possibile aggiungere altri tipi di credenziali nel corso del tempo.

Valore	Descrizione
Windows	La connessione usa l'autenticazione di Windows per connettersi. Supportato solo per i gateway locali.
Anonymous	La connessione usa l'autenticazione anonima per connettersi.
Basic	La connessione usa l'autenticazione di base per connettersi.
Key	La connessione usa l'autenticazione della chiave per connettersi.
OAuth2	La connessione usa l'autenticazione OAuth 2.0 per connettersi.
WindowsWithoutImpersonation	La connessione usa Windows (senza l'opzione per la rappresentazione) per connettersi. Supportato solo per i gateway locali (modalità personale).
SharedAccessSignature	La connessione usa l'autenticazione di firma di accesso condiviso (SAS) per connettersi.
ServicePrincipal	La connessione usa l'autenticazione dell'entità servizio per connettersi.
WorkspaceIdentity	La connessione usa l'autenticazione dell'identità dell'area di lavoro per connettersi.

DataType

Enumerazione

Tipo di dati del valore del parametro di creazione della connessione. È possibile aggiungere valori aggiuntivi del tipo di dati nel tempo.

Valore	Descrizione
Text	Usare il testo come valore di input del parametro.
Number	Usare number come valore di input del parametro (integer o a virgola mobile).
Boolean	Usare boolean come valore di input del parametro. False: il valore è false, True. Il valore è true.
Duration	Usare duration come valore di input del parametro, usando il formato _P(n)DT(n)H(n)M(n)S. Ad esempio: P3DT4H30M10S (per 3 giorni, 4 ore, 30 minuti e 10 secondi).
Date	Usare date come valore di input del parametro, usando il formato AAAA-MM-DD.
DateTime	Usare data e ora come valore di input del parametro, usando YYYY-MM-DDTHH:mm:ss. Formato FFFZ.
DateTimeZone	Usare il fuso orario di data come valore di input del parametro, usando YYYY-MM-DDTHH:mm:ss. Formato FFF±hh:mm.
Time	Usare time come valore di input del parametro usando HH:mm:ss. Formato FFFZ.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

KeyCredentials

Object

Credenziali per Key CredentialType.

Nome	Tipo	Descrizione
credentialType	string: Key	Tipo di credenziale della connessione.
key	string	Tasto.

ListConnectionDetails

Object

Output dei dettagli della connessione per le operazioni di elenco.

Nome	Tipo	Descrizione
path	string	Percorso della connessione.
type	string	Tipo di connessione.

ListCredentialDetails

Object

I dettagli delle credenziali restituiti durante il recupero di una connessione.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	Impostazione di crittografia della connessione utilizzata durante la connessione di test.
credentialType	CredentialType	Tipo di credenziale della connessione.
singleSignOnType	SingleSignOnType	Tipo di accesso Single Sign-On della connessione.
skipTestConnection	boolean	Indica se la connessione deve ignorare la connessione di test durante la creazione e l'aggiornamento. True: ignorare la connessione di test, False: non ignorare la connessione di test.

OnPremisesCredentialEntry

Object

ID gateway e credenziali serializzate crittografate.

Nome	Tipo	Descrizione
encryptedCredentials	string	La .json serializzata crittografata dell'elenco di coppie nome-valore. Il nome è un nome di credenziale e un valore è un valore di credenziale. La crittografia viene eseguita usando l'algoritmo di crittografia Rivest-Shamir-Adleman (RSA) con la chiave pubblica del membro del gateway locale.
gatewayId	string (uuid)	ID oggetto del gateway.

OnPremisesGatewayConnection

Object

Connessione che si connette tramite il gateway dati locale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectivityType	string: OnPremisesGateway	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway della connessione.
id	string (uuid)	ID oggetto della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

OnPremisesGatewayCredentials

Object

Credenziali per l'autenticazione tramite un gateway locale.

Nome	Tipo	Descrizione
credentialType	CredentialType	Tipo di credenziale della connessione.
values	OnPremisesCredentialEntry[]	Payload delle credenziali da inviare al gateway locale.

OnPremisesGatewayPersonalConnection

Object

Connessione che si connette tramite un gateway dati locale personale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectivityType	string: OnPremisesGatewayPersonal	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway della connessione.
id	string (uuid)	ID oggetto della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

PersonalCloudConnection

Object

Connessione che si connette tramite il cloud e non può essere condivisa.

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectivityType	string: PersonalCloud	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
id	string (uuid)	ID oggetto della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

PrivacyLevel

Enumerazione

Impostazione del livello di privacy della connessione. È possibile aggiungere livelli di privacy aggiuntivi nel tempo.

Valore	Descrizione
None	Non è configurata alcuna impostazione del livello di privacy.
Private	Le connessioni impostate su private contengono informazioni riservate o riservate. La visibilità può essere limitata agli utenti autorizzati. I dati di una connessione privata non verranno piegati ad altre connessioni, incluse altre connessioni private.
Organizational	Le connessioni impostate sull'organizzazione possono passare a connessioni private e ad altre connessioni organizzative. Non possono piegarsi alle connessioni pubbliche. La visibilità è impostata su un gruppo attendibile.
Public	I file, le connessioni Internet e i dati della cartella di lavoro possono essere impostati su pubblico. I dati possono essere piegati ad altre connessioni. La visibilità è disponibile per tutti.

ServicePrincipalCredentials

Object

Credenziali per ServicePrincipal CredentialType.

Nome	Tipo	Descrizione
credentialType	string: ServicePrincipal	Tipo di credenziale della connessione.
servicePrincipalClientId	string (uuid)	ID client dell'entità servizio.
servicePrincipalSecret	string	Segreto dell'entità servizio.
tenantId	string (uuid)	ID tenant dell'entità servizio.

ShareableCloudConnection

Object

Connessione che si connette attraverso il cloud.

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectivityType	string: ShareableCloud	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
id	string (uuid)	ID oggetto della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

SharedAccessSignatureCredentials

Object

Credenziali per SharedAccessSignature CredentialType.

Nome	Tipo	Descrizione
credentialType	string: SharedAccessSignature	Tipo di credenziale della connessione.
token	string	Token.

SingleSignOnType

Enumerazione

Tipo di accesso Single Sign-On della connessione. È possibile aggiungere altri tipi di accesso Single Sign-On nel tempo.

Valore	Descrizione
None	La connessione non usa l'accesso Single Sign-On per connettersi.
Kerberos	La connessione usa l'accesso Single Sign-On Kerberos per connettersi.
MicrosoftEntraID	La connessione usa l'accesso Single Sign-On di Microsoft Entra ID per connettersi.
SecurityAssertionMarkupLanguage	La connessione usa l'accesso Single Sign-On SAML (Security Assertion Markup Language) per la connessione.
KerberosDirectQueryAndRefresh	Per connettersi, la connessione usa Kerberos DirectQuery e Refresh.

VirtualNetworkGatewayConnection

Object

Connessione che si connette tramite un gateway dati di rete virtuale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectivityType	string: VirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway della connessione.
id	string (uuid)	ID oggetto della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

WindowsCredentials

Object

Credenziali per Windows CredentialType.

Nome	Tipo	Descrizione
credentialType	string: Windows	Tipo di credenziale della connessione.
password	string	La password.
username	string	Il nome utente.

WindowsWithoutImpersonationCredentials

Object

Credenziali per WindowsWithoutImpersonation CredentialType.

Nome	Tipo	Descrizione
credentialType	string: WindowsWithoutImpersonation	Tipo di credenziale della connessione.

WorkspaceIdentityCredentials

Object

Credenziali per WorkspaceIdentity CredentialType.

Nome	Tipo	Descrizione
credentialType	string: WorkspaceIdentity	Tipo di credenziale della connessione.

Condividi tramite

Connections - Create Connection

Permissions

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interface

Corpo della richiesta

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Risposte

Esempio

Cloud example

Esempio di richiesta

Risposta di esempio

On-premises gateway example

Esempio di richiesta

Risposta di esempio

Virtual network gateway example

Esempio di richiesta

Risposta di esempio

Definizioni

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