[BUG] Create a connection for Fabric SQL fails

[edkreuk]

Bug Description

When creating a new connection for FabricSQL it Fails

!fab create .connections/CON_FMD_FABRIC_SQL1.Connection -P connectionDetails.type=FabricSql,connectionDetails.creationMethod=FabricSql.Contents,connectionDetails.parameters.dummy=x, credentialDetails.type=ServicePrincipal,credentialDetails.servicePrincipalClientId=$app_id,credentialDetails.servicePrincipalSecret=$secret,credentialDetails.tenantId=$tenant_id

Creating a new Connection... ! Parameter dummy is not used by the creation method FabricSql.Contents and will be ignored x create: [InvalidInput] Credential type is required. Supported credential types: OAuth2, ServicePrincipal

When I removed the option connectionDetails.parameters.dummy=x, what was suggested for Fabric Pipelines I get the following error
Creating a new Connection...
x create: [InvalidInput] Parameters are required for the connection creation method. Required parameters are: . Optional parameters are:

fabric-cli version

1.3.1

Python version

3.11

Operating System

Windows

CLI Mode

Interactive mode

Authentication Method

Interactive browser login

Steps to Reproduce

Fabric Notebook
Pip install fabricli

Define tenant_id, secret and app_id

!fab create .connections/CON_FMD_FABRIC_SQL1.Connection -P connectionDetails.type=FabricSql,connectionDetails.creationMethod=FabricSql.Contents,credentialDetails.type=ServicePrincipal,credentialDetails.servicePrincipalClientId=$app_id,credentialDetails.servicePrincipalSecret=$secret,credentialDetails.tenantId=$tenant_id

Expected Behavior

That we can create the Connection

Actual Behavior

Creating connection fails

Additional Context

From the API, this is the context {
"type": "FabricSql",
"creationMethods": [
{
"name": "FabricSql.Contents",
"parameters": []
}
],
"supportedCredentialTypes": [
"OAuth2",
"ServicePrincipal"
],
"supportedConnectionEncryptionTypes": [
"NotEncrypted"
],
"supportsSkipTestConnection": false,
"supportedCredentialTypesForUsageInUserControlledCode": null
},

Possible Solution

No response

[aviatco]

/triaged

Hi @edkreuk Thank you for raising this issue.
After reviewing the command, I noticed there’s a space before credentialDetails.type=ServicePrincipal, which causes incorrect parameter parsing. This is a bug that needs to be fixed.
For now, please avoid using spaces after the comma.
Additionally, for connectionDetails.type=FabricSql, the only supported credentialDetails.type is OAuth2. Using ServicePrincipal will still result in the following error:
x create: [InvalidInput] Invalid credential type. Supported Credentials for FabricSql: OAuth2.

Regarding connectionDetails.parameters, a fix will be introduced in upcoming releases so that it will no longer be mandatory when not required.

[microsoft-github-policy-service]

Triage has been completed for this issue.

[edkreuk]

@aviatco when running the command for Oauth2
!fab create .connections/CON_FMD_FABRIC_SQL1.Connection -P connectionDetails.type=FabricSql,connectionDetails.creationMethod=FabricSql.Contents,connectionDetails.parameters.dummy=x,credentialDetails.type=OAuth2

Creating a new Connection...
! Parameter dummy is not used by the creation method FabricSql.Contents and will be ignored
x create: [NotSupported] OAuth2 credential type is not supported

So when running for ServicePrincipal we get the ServicePrincipal error and when Oauth2 the Oauth2 error.

Supported parameters from the Fabric API are:
{
"type": "FabricSql",
"creationMethods": [
{
"name": "FabricSql.Contents",
"parameters": []
}
],
"supportedCredentialTypes": [
"OAuth2",
"ServicePrincipal"
],
"supportedConnectionEncryptionTypes": [
"NotEncrypted"
],
"supportsSkipTestConnection": false,
"supportedCredentialTypesForUsageInUserControlledCode": null
},