[FEAT] fabric_sql_database (return connection details)

[garddolau]

🚀 Feature description

Great to get the ability to deploy a fabric_sql_database but to make it useful to downstream terraform config it would be great if it returned the connection details for the created database (similar to how fabric_warehouse does).

Something like below in the state maybe

      "instances": [
        {
          "schema_version": 0,
          "attributes": {
            "description": "example",
            "display_name": "sql_example",
            "id": "f852eea4-e36c-4590-8b36-20569cae7fb8",
            "timeouts": null,
            "workspace_id": "c4ddf736-752f-4a03-8970-399d969d4c4a",
	    "properties": {
              "server_fqdn": "dqjx2zrgh4uejnetrut54cdkau-g3353rbpoubuvclqhgoznhkmji.database.fabric.microsoft.com",
              "database_name": "sql_example-f852eea4-e36c-4590-8b36-20569cae7fb8"
            },
          },
          "sensitive_attributes": []
        }
      ]

🔈 Motivation

In order by create downstream terraform config eg, add connection details to key vault we need the fabric_sql_database create to return to server_fqdn & the database_name

🛰 Alternatives

We can get:
database_name via a concat of display_name and id
server_fqdn via a warehouse create output and swapping .datawarehouse.fabric.microsoft.com with .database.fabric.microsoft.com

Neither are ideal though

🚧 Potential Configuration / Desired Solution

Output similar to below

      "instances": [
        {
          "schema_version": 0,
          "attributes": {
            "description": "example",
            "display_name": "sql_example",
            "id": "f852eea4-e36c-4590-8b36-20569cae7fb8",
            "timeouts": null,
            "workspace_id": "c4ddf736-752f-4a03-8970-399d969d4c4a",
	    "properties": {
              "server_fqdn": "dqjx2zrgh4uejnetrut54cdkau-g3353rbpoubuvclqhgoznhkmji.database.fabric.microsoft.com",
              "database_name": "sql_example-f852eea4-e36c-4590-8b36-20569cae7fb8"
            },
          },
          "sensitive_attributes": []
        }
      ]

📎 Additional context

No response

☑️ Acceptance Criteria

Once a fabric_sql_database is deployed we can get its server_fqdn & database_name

🔰 Code of Conduct

• I agree to follow this project's Code of Conduct.

[DariuszPorowski]

Hi @garddolau Thanks for sharing this idea.

@cisraeli @badeamarjieh @OrBaubergMicrosoft @Halamish51
May you check with SQL DB team if they have any plans (if yes, then what is ETA) to onboard properties to SQL Database API for Get and List operations?

• https://learn.microsoft.com/en-us/rest/api/fabric/sqldatabase/items/get-sql-database?tabs=HTTP
• https://learn.microsoft.com/en-us/rest/api/fabric/sqldatabase/items/list-sql-databases?tabs=HTTP

[garddolau]

Hi @DariuszPorowski thanks for reply.

Do you know anyway I can log feature requests with the Fabric Rest API team?
I can log on the Fabric Ideas portal but not quite the same as logging direct with the team via github or something similar.

Cheers,
Darren

[garddolau]

API appears to be returning properties

{
    "id": "2a73f1b7-ac69-414f-b4b9-99f4e498ca90",
    "type": "SQLDatabase",
    "displayName": "sql_example",
    "description": "sql_example",
    "workspaceId": "eec9a2f6-4d01-4adc-b1fc-9d54784acefc",
    "properties": {
        "$type": "SqlDbNativePublicExtendedProperties",
        "connectionInfo": "Data Source=dqjx2zrgh4uejnetrut54cdkau-62rmt3qbjxoevmp4tvkhqswo7q.database.fabric.microsoft.com,1433;Initial Catalog=sql_example-2a73f1b7-ac69-414f-b4b9-99f4e498ca90;Multiple Active Result Sets=False;Connect Timeout=30;Encrypt=True;Trust Server Certificate=False",
        "databaseName": "sql_example-2a73f1b7-ac69-414f-b4b9-99f4e498ca90",
        "serverFqdn": "dqjx2zrgh4uejnetrut54cdkau-62rmt3qbjxoevmp4tvkhqswo7q.database.fabric.microsoft.com,1433"
    }
}

[DariuszPorowski]

Hi @garddolau

We are not doing direct API calls, instead we are utilizing Go SDK for Fabric https://aka.ms/FabricSDK/Go which is generated based on the same source as the documentation. Only when we have it in the SDK will we add it to the provider. You can monitor the status on the official documentation page: https://learn.microsoft.com/en-us/rest/api/fabric/sqldatabase/items/get-sql-database (currently properties are not available)

[garddolau]

Hi @DariuszPorowski, thanks for the update on how it works and the dependency on the official documentation,

[garddolau]

Fixed in PR #430