Key Vault backed CosmosDB Linked Service in Synapse Workspace not showing under Data section

Kholofelo 66

The CosmosDB Linked Service will normally show under the data section of Synapse Workspace.

We have our Synapse Workspace linked to GitHub, to avoid having secrets in GitHub we are using KeyVault for the connection string (as recommended by Microsoft). For this, we have created a KeyVault Linked Service in Synapse.

We have then created a linked Service for CosmosDB that uses the KeyVault to get the connection string. The LinkedService is created properly and we can even use it in a dataflow without issues.

The issue, however, is that the CosmosDB linked service does not show under the Data Section of Synapse Workspace (I have checked and it does show if we don't use the key-vault approach)

How can we resolve this and have the keyvault backed CosmosDB linked service show in the data section? It helps when we need to do queries to have it listed there.

2 answers

Kholofelo 66 Reputation points

2022-03-10T15:56:07.963+00:00

I got some feedback from the Synapse Product team and it turns out this is a known issue and there is yet to be an ETA to have it fixed.

See below an extract from the feedback:

Currently the synapse studio doesn’t show the connected cosmos DB if the connection string is from Azure Key Vault. We have plans to introduce a message/warning to users stating ‘ Cosmos DB won’t be seen under ‘Data’ section if Azure Key vault is chosen.

So for anyone who is wondering, currently if you want the CosmosDB link to show under 'Data' do not use a Key Vault backed Linked Service.
Please sign in to rate this answer.

1 person found this answer helpful.
Kholofelo 66 Reputation points

2022-03-10T15:57:24.7+00:00

@AnnuKumari-MSFT see answer above.

AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-03-11T07:57:22.077+00:00

@khelofelo ,
Thanks for sharing the resolution details.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.
AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-02-21T08:14:16.997+00:00
Hi @Kholofelo ,
Thankyou for using Microsoft Q&A platform and posting your query.
My understanding is that you have created a keyVault that is storing the secret pairs for Cosmos DB data source and a linked service that is using the keyvault. However, you want to understand why linked service is not visible in Linked tab under Data menu inside the Synapse Workspace. Please correct me if my understanding is wrong.

Linked Tab under data menu inside Azure Synapse Workspace are meant to have two things: 1. Storage account 2. Integration dataset. You can only view linked services inside External connections under manage tab .

Below are the images you can refer to:
1. Linked tab under data menu can only hold storage account details and Dataset details

2. Linked services are present under manage tab

Please checkout the following video for more details:
https://youtu.be/DZneFEqH-H4?list=PLMWaZteqtEaIZxPCw_0AO1GsqESq3hZc6&t=234

Hope this will help. Please let us know if any further queries.

------------------------------

Please don't forget to click on or upvote button whenever the information provided helps you.
Original posters help the community find answers faster by identifying the correct answer. Here is how

Want a reminder to come back and check responses? Here is how to subscribe to a notification

If you are interested in joining the VM program and help shape the future of Q&A: Here is how you can be part of Q&A Volunteer Moderators
Please sign in to rate this answer.
Kholofelo 66 Reputation points

2022-02-21T16:10:11.567+00:00

Hi, @AnnuKumari-MSFT . Thank you for your response.

The Linked Tab on the Data section can indeed hold CosmosDB linked services as well. See below an example:

I can confirm that I can get the CosmosDB linked service to show in the Linked data section if I don't go via KeyVault. So I need it to show while we are using KeyVault.

AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-02-21T17:11:07.983+00:00

Hi @Kholofelo ,
As mentioned earlier linked tab can store the data in storage account or can connect to external source ( for ex: cosmos db) . Azure Synapse analytics enables us to run near real-time analytics over operational data in Azure Cosmos DB. For doing analysis on Cosmos DB data inside synapse , the pre-requisite is to enable Azure Synapse link and to have analytical store for cosmosDB. What you see is not the linked service but the Cosmos DB data store itself.
For more details , please refer to the following article : https://learn.microsoft.com/en-us/azure/cosmos-db/configure-synapse-link#enable-synapse-link
Thanks!

Hope this will help. Please let us know if any further queries. Please consider clicking Accept Answer and kindly Up-Vote for the same as accepted answers help community as well.

Kholofelo 66 Reputation points

2022-02-21T19:15:14.527+00:00

Hi @AnnuKumari-MSFT . Thanks for the feedback.

Maybe I'm missing something here. We do have Synapse Link working. We have been able to get the CosmosDB external source to show on Linked Tab. However, it only shows if we don't get the connection string from a KeyVault linked service.

When adding an external source for CosmosDB this is the UI that is shown.

As you can see there is a selection between "Connection string" and "Azure Key Vault".

When selecting "Connection string" option, the CosmosDB shows under the linked tab

When selecting "Azure Key Vault" option, the CosmosDB does not show under the linked tab

My expectation should be that the actual CosmosDB store should show on linked tab regardless of whether we took "Connection string" or"Azure Key Vault" option. Does that make sense?

AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-02-23T11:16:34.593+00:00

Hi @Kholofelo ,
I tried to repro your scenario.

Created provisioned throughput (not serverless) cosmosDB

Enabled Azure synapse link

Created container with Analytical store ON

Created a Key vault and stored CosmosDB connection string in KV secret

Created a linked service in Azure Synapse which is using the above created KV

I can still see the cosmos DB external source data in the linked tab of my data menu. If your issue still persist make sure, the first three points are covered in your case , i.e make sure the container which you are using in cosmos DB is having Analytical store set as ON. If not, you need to create a new container as you can't set analytical store as ON for an existing container.

If this answers your query, do click Accept Answer and Up-Vote for the same. And, if you have any further query do let us know.

Kholofelo 66 Reputation points

2022-02-24T08:13:52.267+00:00

Hi @AnnuKumari-MSFT . Thank you once again.

I have followed all the steps, still no joy. I have opened a support request.

AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-02-24T18:04:32.057+00:00

Hi @Kholofelo ,
Please let us know if the issue has been resolved . It would be much appreciated if you share with us the resolution details as well.Just checking in to see if you got a chance to see previous response. If the suggested response helped you, please click Accept Answer and kindly upvote the same as accepted answers help community as well. If you have any further query do comment. Thanks!

AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-03-02T16:17:05.753+00:00

Hi @Kholofelo ,
Just checking back to see if you got the resolution for the query. Please do share that same with the community as it can be helpful to others . If the above answer helped , kindly consider hitting Accept answer button. Thanks!

Kholofelo 66 Reputation points

2022-03-02T21:04:03.263+00:00

Not yet resolved @AnnuKumari-MSFT . The issue is now with the Synapse product team.

AnnuKumari-MSFT 32,906 Reputation points Microsoft Employee

2022-03-10T15:35:17.187+00:00

Hi @Kholofelo ,
Just following up to see if you got the resolution. Please share the mitigation steps with the community so that it will be helpful for others who face the same issue. Thanks in advance! Please consider hitting Accept answer button as accepted answers help community as well. Thanks!
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.