How to rename Linked Services in Azure Data Factory
If you’re reading this, you’ve probably hit the same issue I did! How do you rename a linked service in Azure Data Factory without manually updating each dataset that uses the linked service?
As the time of writing, there isn’t a good solution. I’d expect the functionality to appear in the GUI tool eventually, but it’s not there yet. Here’s a way to do it.
This guide assumes that you are using the following:
- ADF V2
- Git for VSTS connected with your ADF.
- You can do this without using Git. Instead of cloning the repository, export the ARM template instead. Perform the find and replace on the template and parameter file, then import it again.
- Be warned, this is much more messy.
- Are not using Azure Key Vault - There’s currently glitch that will cause your connection to error if you set a dataset to a new LinkedService using a Key Vault for connection details. There is a workaround however. Create a new linked service as specified below, but don’t use Key Vault to store the credentials. Perform upto step 6, then change your connection to use the Key Vault.
- Create a new branch. I called mine
- Create your new linked services you wish to use in the GUI.
- Open this branch in your local VSTS. (You will need to connect to the git repo, clone a local version and swap to the
- Perform a find and replace (
CTRL + F), searching for the linked service you wish to rename, and replacing it with the name of your newly created linked service.
- Delete your old linked service JSON file.
- Commit the changes and sync with the remote repository
- Open up the
rename-linked-services branch in your ADF. Test your connection of the linked service, and run a pipeline using it.
- If it’s working, merge the changes into your dev branch.