Connections - Update Connection

Service:: Core

Versione API:: v1

Aggiorna la connessione in base all'ID.
Per crittografare le credenziali, vedere Configurare le credenziali a livello di codice.

Permissions

Il chiamante deve disporre dell'autorizzazione per la connessione o l'autorizzazione di amministratore per il gateway della connessione.

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

PATCH https://api.fabric.microsoft.com/v1/connections/{connectionId}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
connectionId	path	True	string (uuid)	ID della connessione.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Aggiorna una connessione che si connette tramite un gateway dati di rete virtuale di streaming.
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectivityType	True	string: OnPremisesGateway	Tipo di connettività della connessione.
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	Dettagli delle credenziali della connessione.
displayName		string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel		PrivacyLevel	Livello di privacy della connessione.

UpdateOnPremisesGatewayPersonalConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectivityType	True	string: OnPremisesGatewayPersonal	Tipo di connettività della connessione.
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	Dettagli delle credenziali della connessione.
privacyLevel		PrivacyLevel	Livello di privacy della connessione.

UpdatePersonalCloudConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectivityType	True	string: PersonalCloud	Tipo di connettività della connessione.
allowConnectionUsageInGateway		boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
credentialDetails		UpdateCredentialDetails	Dettagli delle credenziali della connessione.
privacyLevel		PrivacyLevel	Livello di privacy della connessione.

UpdateShareableCloudConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectivityType	True	string: ShareableCloud	Tipo di connettività della connessione.
allowConnectionUsageInGateway		boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
credentialDetails		UpdateCredentialDetails	Dettagli delle credenziali della connessione.
displayName		string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel		PrivacyLevel	Livello di privacy della connessione.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Aggiorna una connessione che si connette tramite un gateway dati di rete virtuale di streaming.

Nome	Necessario	Tipo	Descrizione
connectivityType	True	string: StreamingVirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails		UpdateCredentialDetails	Dettagli delle credenziali della connessione.
displayName		string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel		PrivacyLevel	Livello di privacy della connessione.

UpdateVirtualNetworkGatewayConnectionRequest

Nome	Necessario	Tipo	Descrizione
connectivityType	True	string: VirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails		UpdateCredentialDetails	Dettagli delle credenziali della connessione.
displayName		string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel		PrivacyLevel	Livello di privacy della connessione.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Operazione riuscita.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: EntityNotFound: impossibile trovare la risorsa richiesta. InsufficientPermissionsToManageConnection: il chiamante dispone di autorizzazioni insufficienti per gestire la connessione. DuplicateConnectionName: il nome della connessione è già in uso. IncorrectCredentials: non è stato possibile stabilire la connessione usando l'input Credenziali. UpdateGatewayConnectionFailed: non è stato possibile aggiornare la connessione gateway.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OK. Operazione riuscita.

429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

EntityNotFound: impossibile trovare la risorsa richiesta.
InsufficientPermissionsToManageConnection: il chiamante dispone di autorizzazioni insufficienti per gestire la connessione.
DuplicateConnectionName: il nome della connessione è già in uso.
IncorrectCredentials: non è stato possibile stabilire la connessione usando l'input Credenziali.
UpdateGatewayConnectionFailed: non è stato possibile aggiornare la connessione gateway.

Esempio

On-premises gateway (personal mode) example

On-premises gateway example

Personal cloud example

Shareable cloud example

Streaming virtual network gateway example

Virtual network gateway example

On-premises gateway (personal mode) example

Esempio di richiesta

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/ef8f408d-2ab7-4a18-b662-9251febda49c

{
  "connectivityType": "OnPremisesGatewayPersonal",
  "credentialDetails": {
    "credentials": {
      "credentialType": "WindowsWithoutImpersonation",
      "encryptedCredentials": "************************************"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "ef8f408d-2ab7-4a18-b662-9251febda49c",
  "gatewayId": "429a773e-5633-45ee-8584-a192bd79c16a",
  "connectivityType": "OnPremisesGatewayPersonal",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;reporting"
  },
  "privacyLevel": "Private",
  "credentialDetails": {
    "credentialType": "WindowsWithoutImpersonation",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

On-premises gateway example

Esempio di richiesta

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/70b17680-48f1-4729-9df6-02576647dc3a

{
  "connectivityType": "OnPremisesGateway",
  "displayName": "ContosoSalesOnPremisesConnection",
  "credentialDetails": {
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "c6961028-1309-4183-9799-a0b0fa28a235",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "70b17680-48f1-4729-9df6-02576647dc3a",
  "displayName": "ContosoSalesOnPremisesConnection",
  "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Windows",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Personal cloud example

Esempio di richiesta

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/7a0369b2-58c4-4b67-b3f3-92156a95f1cd

{
  "connectivityType": "PersonalCloud",
  "privacyLevel": "Organizational"
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "PersonalCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;finances"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "OAuth2",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Shareable cloud example

Esempio di richiesta

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/fa968eee-8075-48f6-8c6d-41260ee1396d

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection"
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
  "displayName": "ContosoCloudConnection",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;networks"
  },
  "privacyLevel": "Public",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": true
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Streaming virtual network gateway example

Esempio di richiesta

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "StreamingVirtualNetworkGateway",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "StreamingVirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  },
  "myRole": "Owner"
}

Virtual network gateway example

Esempio di richiesta

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "VirtualNetworkGateway",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Definizioni

Nome	Descrizione
AnonymousCredentials	Credenziali per CredentialType anonimo.
BasicCredentials	Credenziali per CredentialType di base.
ConnectionEncryption	Tipo di crittografia della connessione. È possibile aggiungere altri valori di crittografia della connessione nel tempo.
ConnectionRecency	Rappresenta i dettagli della recency sulla connessione.
ConnectionRole	Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.
ConnectivityType	Tipo di connettività della connessione. È possibile aggiungere altri tipi di connettività nel tempo.
CredentialType	Tipo di credenziale della connessione. È possibile aggiungere altri tipi di credenziali nel corso del tempo.
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
KeyCredentials	Credenziali per Key CredentialType.
KeyPairCredentials	Credenziali per KeyPair CredentialType.
KeyVaultSecretReference	Riferimento a un segreto archiviato in Azure Key Vault.
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.
OnPremisesGatewayPersonalCredentials	Credenziali per l'autenticazione tramite un gateway locale (modalità 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.
StreamingVirtualNetworkGatewayConnection	Connessione che si connette tramite un gateway dati di rete virtuale di streaming.
UpdateCredentialDetails	Input dei dettagli delle credenziali per l'aggiornamento di una connessione.
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	Input dei dettagli delle credenziali per l'aggiornamento di una connessione gateway locale.
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	Input dei dettagli delle credenziali per l'aggiornamento di una connessione gateway locale.
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Aggiorna una connessione che si connette tramite un gateway dati di rete virtuale di streaming.
UpdateVirtualNetworkGatewayConnectionRequest
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

Oggetto

Credenziali per CredentialType anonimo.

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

BasicCredentials

Oggetto

Credenziali per CredentialType di base.

Nome	Tipo	Descrizione
credentialType	string: Basic	Tipo di credenziale della connessione.
password	string	La password. Usare password o passwordReference. Non è possibile usare entrambi contemporaneamente
passwordReference	KeyVaultSecretReference	Riferimento a una password archiviata in Azure Key Vault. Usare password o passwordReference. Non è possibile usare entrambi contemporaneamente.
username	string	Il nome utente.

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.

ConnectionRecency

Oggetto

Rappresenta i dettagli della recency sulla connessione.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Timestamp quando la connessione è stata creata in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Timestamp quando la connessione è stata associata più di recente a qualsiasi elemento in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Timestamp quando le credenziali di connessione sono state usate più di recente nell'ora UTC, usando il formato AAAA-MM-GGTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Timestamp quando la connessione è stata associata più di recente a qualsiasi elemento dall'utente chiamante in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Timestamp quando le credenziali di connessione sono state usate più di recente dall'utente chiamante in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.

ConnectionRole

Enumerazione

Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.

Valore	Descrizione
User	Abilita l'accesso utente per la connessione.
UserWithReshare	Abilita l'utente con accesso di ricondivisione per la connessione.
Owner	Abilita l'accesso alla proprietà per la connessione.
PendingOwner	La proprietà della connessione non è ancora effettiva; l'entità deve aggiornare le credenziali di connessione (usando l'API di connessione di aggiornamento) per renderla effettiva.

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.
StreamingVirtualNetworkGateway	La connessione si connette tramite un gateway dati di rete virtuale di streaming.
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

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.
KeyPair	La connessione usa l'autenticazione della coppia di chiavi per connettersi.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

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

Oggetto

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.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

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.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

KeyCredentials

Oggetto

Credenziali per Key CredentialType.

Nome	Tipo	Descrizione
credentialType	string: Key	Tipo di credenziale della connessione.
key	string	Tasto. Usare key o keyReference. Non è possibile usare entrambi contemporaneamente.
keyReference	KeyVaultSecretReference	Riferimento a una chiave archiviata in Azure Key Vault. Usare key o keyReference. Non è possibile usare entrambi contemporaneamente.

KeyPairCredentials

Oggetto

Credenziali per KeyPair CredentialType.

Nome	Tipo	Descrizione
credentialType	string: KeyPair	Tipo di credenziale della connessione.
identifier	string	Identificatore della chiave.
passphrase	string	Passphrase per la chiave privata se la chiave privata è crittografata.
privateKey	string	Chiave privata basata sullo standard PKCS #8.

KeyVaultSecretReference

Oggetto

Riferimento a un segreto archiviato in Azure Key Vault.

Nome	Tipo	Descrizione
connectionId	string (uuid)	ID connessione della connessione key vault.
secretName	string	Nome del segreto in Key Vault.
version	string	Versione del segreto in Key Vault.

ListConnectionDetails

Oggetto

Output dei dettagli della connessione per le operazioni di elenco.

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

ListCredentialDetails

Oggetto

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

Oggetto

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

Oggetto

Connessione che si connette tramite il gateway dati locale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla 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 tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

OnPremisesGatewayCredentials

Oggetto

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

Oggetto

Connessione che si connette tramite un gateway dati locale personale.

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla 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 tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

OnPremisesGatewayPersonalCredentials

Oggetto

Credenziali per l'autenticazione tramite un gateway locale (modalità personale).

Nome	Tipo	Descrizione
credentialType	CredentialType	Tipo di credenziale della connessione.
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 gateway locale.

PersonalCloudConnection

Oggetto

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.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: PersonalCloud	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
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

Oggetto

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. Usare servicePrincipalSecret o servicePrincipalSecretReference. Non è possibile usare entrambi contemporaneamente.
servicePrincipalSecretReference	KeyVaultSecretReference	Riferimento a un segreto dell'entità servizio archiviato in Azure Key Vault. Usare servicePrincipalSecret o servicePrincipalSecretReference. Non è possibile usare entrambi contemporaneamente.
tenantId	string (uuid)	ID tenant dell'entità servizio.

ShareableCloudConnection

Oggetto

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.
allowUsageInUserControlledCode	boolean	Consentire l'uso di questa connessione con elementi che consentono codice controllato dall'utente, ad esempio Notebook.
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: ShareableCloud	Tipo di connettività della connessione.
credentialDetails	ListCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione.
gatewayId	string (uuid)	ID oggetto gateway tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

SharedAccessSignatureCredentials

Oggetto

Credenziali per SharedAccessSignature CredentialType.

Nome	Tipo	Descrizione
credentialType	string: SharedAccessSignature	Tipo di credenziale della connessione.
token	string	Token. Usare token o tokenReference. Non è possibile usare entrambi contemporaneamente.
tokenReference	KeyVaultSecretReference	Riferimento a un token archiviato in Azure Key Vault. Usare token o tokenReference. Non è possibile usare entrambi contemporaneamente.

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.

StreamingVirtualNetworkGatewayConnection

Oggetto

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

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla connessione.
connectivityType	string: StreamingVirtualNetworkGateway	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.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

UpdateCredentialDetails

Oggetto

Input dei dettagli delle credenziali per l'aggiornamento di una connessione.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	Impostazione di crittografia della connessione utilizzata durante la connessione di test.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Credenziali 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.

UpdateOnPremisesGatewayConnectionRequest

Oggetto

Nome	Tipo	Descrizione
connectivityType	string: OnPremisesGateway	Tipo di connettività della connessione.
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

UpdateOnPremisesGatewayCredentialDetails

Oggetto

Input dei dettagli delle credenziali per l'aggiornamento di una connessione gateway locale.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	Impostazione di crittografia della connessione utilizzata durante la connessione di test.
credentials	OnPremisesGatewayCredentials	Credenziali 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.

UpdateOnPremisesGatewayPersonalConnectionRequest

Oggetto

Nome	Tipo	Descrizione
connectivityType	string: OnPremisesGatewayPersonal	Tipo di connettività della connessione.
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	Dettagli delle credenziali della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

UpdateOnPremisesGatewayPersonalCredentialDetails

Oggetto

Input dei dettagli delle credenziali per l'aggiornamento di una connessione gateway locale.

Nome	Tipo	Descrizione
connectionEncryption	ConnectionEncryption	Impostazione di crittografia della connessione utilizzata durante la connessione di test.
credentials	OnPremisesGatewayPersonalCredentials	Credenziali 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.

UpdatePersonalCloudConnectionRequest

Oggetto

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
connectivityType	string: PersonalCloud	Tipo di connettività della connessione.
credentialDetails	UpdateCredentialDetails	Dettagli delle credenziali della connessione.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

UpdateShareableCloudConnectionRequest

Oggetto

Nome	Tipo	Descrizione
allowConnectionUsageInGateway	boolean	Consentire l'utilizzo di questa connessione con gateway dati locali o gateway dati di rete virtuale.
connectivityType	string: ShareableCloud	Tipo di connettività della connessione.
credentialDetails	UpdateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Oggetto

Aggiorna una connessione che si connette tramite un gateway dati di rete virtuale di streaming.

Nome	Tipo	Descrizione
connectivityType	string: StreamingVirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	UpdateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

UpdateVirtualNetworkGatewayConnectionRequest

Oggetto

Nome	Tipo	Descrizione
connectivityType	string: VirtualNetworkGateway	Tipo di connettività della connessione.
credentialDetails	UpdateCredentialDetails	Dettagli delle credenziali della connessione.
displayName	string	Nome visualizzato della connessione. La lunghezza massima è di 200 caratteri.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

VirtualNetworkGatewayConnection

Oggetto

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

Nome	Tipo	Descrizione
connectionDetails	ListConnectionDetails	Dettagli della connessione.
connectionRecency	ConnectionRecency	Dettagli sulla 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 tramite il quale viene stabilita la connessione. Per le connessioni cloud, si tratta dell'ID del gateway virtuale.
id	string (uuid)	ID oggetto della connessione.
myRole	ConnectionRole	Ruolo effettivo dell'entità chiamante sulla connessione. Quando l'entità fa parte di più gruppi di sicurezza con ruoli diversi, viene restituito il ruolo più alto. Se l'entità non ha alcun ruolo nella connessione, questa proprietà non viene restituita.
privacyLevel	PrivacyLevel	Livello di privacy della connessione.

WindowsCredentials

Oggetto

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

Oggetto

Credenziali per WindowsWithoutImpersonation CredentialType.

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

WorkspaceIdentityCredentials

Oggetto

Credenziali per WorkspaceIdentity CredentialType.

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