Connection

Properties

Property	Type	Attributes	Description
connectionDetails	ConnectionDetailsModel	Required	The Connection connection details
connectivityType	'ShareableCloud' | 'VirtualNetworkGateway'	Required	The Connection connectivity type
credentialDetails	ConnectionCredentialDetails	Required	The Connection credential details
displayName	string	Required	The Connection display name
allowConnectionUsageInGateway	bool		Allow this connection to be utilized with on-premises or VNet data gateways. Not applicable when connectivityType is VirtualNetworkGateway
allowUsageInUserControlledCode	bool		Allow this connection to be used with items that allow user-controlled code such as Notebook. Not applicable when connectivityType is VirtualNetworkGateway
gatewayId	string		The Connection gateway object ID. Required when connectivityType is VirtualNetworkGateway
id	string	Read-only, Identifier	The Connection ID
privacyLevel	'None' | 'Organizational' | 'Private' | 'Public'		The Connection privacy level. Defaults to Organizational

ConnectionDetailsModel

Property	Type	Attributes	Description
creationMethod	string	Required	The creation method used to create the connection
type	string	Required	The type of the connection
parameters	ConnectionDetailsParameter[]		The connection parameters
path	string	Read-only	The path of the connection

ConnectionCredentialDetails

Property	Type	Attributes	Description
credentialType	'Anonymous' | 'Basic' | 'Key' | 'KeyPair' | 'ServicePrincipal' | 'SharedAccessSignature' | 'Windows' | 'WindowsWithoutImpersonation' | 'WorkspaceIdentity'	Required	The credential type
basic	ConnectionBasicCredentials		The basic credentials. Required when credentialType is Basic
connectionEncryption	'Any' | 'Encrypted' | 'NotEncrypted'		The connection encryption type. Defaults to NotEncrypted
key	ConnectionKeyCredentials		The key credentials. Required when credentialType is Key
keyPair	ConnectionKeyPairCredentials		The key pair credentials. Required when credentialType is KeyPair
servicePrincipal	ConnectionServicePrincipalCredentials		The service principal credentials. Required when credentialType is ServicePrincipal
sharedAccessSignature	ConnectionSharedAccessSignatureCredentials		The shared access signature credentials. Required when credentialType is SharedAccessSignature
singleSignOnType	'None' | 'Kerberos' | 'KerberosDirectQueryAndRefresh' | 'MicrosoftEntraID' | 'SecurityAssertionMarkupLanguage'		The single sign-on type. Defaults to None
skipTestConnection	bool		Whether the connection should skip the test connection during creation and update. Defaults to false
windows	ConnectionWindowsCredentials		The Windows credentials. Required when credentialType is Windows

ConnectionDetailsParameter

Property	Type	Attributes	Description
name	string	Required	The name of the parameter
value	string	Required	The value of the parameter, expressed as a string. Numbers use invariant formatting, booleans use 'true'/'false', and date, time and duration values use ISO 8601.
dataType	'Text' | 'Number' | 'Boolean' | 'Date' | 'DateTime' | 'DateTimeZone' | 'Duration' | 'Time'		The data type of the parameter. Defaults to Text.

ConnectionBasicCredentials

Property	Type	Attributes	Description
username	string	Required	The username
password	string	Sensitive	The password
passwordReference	ConnectionKeyVaultSecretReference		The Key Vault reference for the password secret

ConnectionKeyCredentials

Property	Type	Attributes	Description
key	string	Sensitive	The key
keyReference	ConnectionKeyVaultSecretReference		The Key Vault reference for the key secret

ConnectionKeyPairCredentials

Property	Type	Attributes	Description
identifier	string	Required	The identifier for the key
privateKey	string	Required, Sensitive	The private key based on the PKCS #8 standard
passphrase	string	Sensitive	The passphrase for the private key if it is encrypted

ConnectionServicePrincipalCredentials

Property	Type	Attributes	Description
clientId	string	Required	The client ID
tenantId	string	Required	The tenant ID
clientSecret	string	Sensitive	The client secret
clientSecretReference	ConnectionKeyVaultSecretReference		The Key Vault reference for the client secret

ConnectionSharedAccessSignatureCredentials

Property	Type	Attributes	Description
token	string	Sensitive	The token
tokenReference	ConnectionKeyVaultSecretReference		The Key Vault reference for the SAS token secret

ConnectionWindowsCredentials

Property	Type	Attributes	Description
password	string	Required, Sensitive	The password
username	string	Required	The username

ConnectionKeyVaultSecretReference

Property	Type	Attributes	Description
connectionId	string	Required	The connection ID of the Key Vault connection
secretName	string	Required	The name of the secret in Key Vault
version	string		The version of the secret in Key Vault