Database connection string with azure keyvault in azure function local.setting.json

Question

Database connection string with azure keyvault in azure function local.setting.json

OS 0

Hi,

I am supporting an azure function someone wrote in c# in donnet frameworkcore 2.2.4. The function app is connecting to database using sql account and usernames and passwords are hardcode in connection string at the moment. We want to use azure keyvault now so that we dont have list password in connection string.

Here is the connection with hardcode username and password in local.setting.json file.

	"SQLConnectionString":"Server=tcp:xxxx-sql.database.windows.net,1433;Initial Catalog=abc-db;Persist Security Info=False;User ID=xxxx;Password=xxxxxx;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"

Can you help me, how can I replace this connection string so that it gets username and password from Key vault secrets? I dont have much deeper knowledge of C#. Thank you for your help.

JamesTran-MSFT 36,826 Reputation points Microsoft Employee

2023-03-10T22:14:23.8833333+00:00
@OS

Thank you for your post and I apologize for the delayed response!

From your issue, I understand that you have an Azure Function which is connecting to a SQL DB using a Username and Password (hardcoded) within the connection string. To avoid listing the password within the connection string, you'd like to leverage the Azure Key Vault and need to replace the connection string so that it gets the username and password from the KV.

When it comes to using Key Vault references within your Azure Functions app, you should be able to use the below syntax.

Reference Syntax:

A Key Vault reference is of the form @Microsoft.KeyVault({referenceString}), where {referenceString} is replaced by one of the following options:

For example, a complete reference would look like the following:

@Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/mysecret/)

Alternatively:

@Microsoft.KeyVault(VaultName=myvault;SecretName=mysecret)

Additional Link - Troubleshooting Key Vault References

I hope this helps! If you have any other questions, please let me know.
JamesTran-MSFT 36,826 Reputation points Microsoft Employee

2023-03-13T18:27:11.66+00:00

@OS

I just wanted to check in and see if you had any other questions or if you were able to resolve this issue?

Your answer

JamesTran-MSFT 36,826 Reputation points Microsoft Employee

2023-03-10T22:14:23.8833333+00:00

@OS

Thank you for your post and I apologize for the delayed response!

From your issue, I understand that you have an Azure Function which is connecting to a SQL DB using a Username and Password (hardcoded) within the connection string. To avoid listing the password within the connection string, you'd like to leverage the Azure Key Vault and need to replace the connection string so that it gets the username and password from the KV.

When it comes to using Key Vault references within your Azure Functions app, you should be able to use the below syntax.

Reference Syntax:

A Key Vault reference is of the form @Microsoft.KeyVault({referenceString}), where {referenceString} is replaced by one of the following options:

For example, a complete reference would look like the following:

@Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/mysecret/)

Alternatively:

@Microsoft.KeyVault(VaultName=myvault;SecretName=mysecret)

Additional Link - Troubleshooting Key Vault References

I hope this helps! If you have any other questions, please let me know.
JamesTran-MSFT 36,826 Reputation points Microsoft Employee

2023-03-13T18:27:11.66+00:00

@OS

I just wanted to check in and see if you had any other questions or if you were able to resolve this issue?

Share via

Database connection string with azure keyvault in azure function local.setting.json

Your answer