[Feedback] Document correction request - Avoid Parameter not defined error when using Parameterized Azure KeyVault linkedservice

[GovindulaRakesh]

Document Correction Proposal: Error when using same parameters for both Service principal ID and Secret name in the pipeline dynamic expression of the Azure KeyVault linked service

Overview

This request provides a step-by-step explanation of the below error when using Azure KeyVault linked service with parameters in another linked service - ADF.

The parameters and expression cannot be resolved for schema operations. Error Message: { "message": "ErrorCode=InvalidTemplate, ErrorMessage=The template function 'linkedService' is not defined or not valid." } Activity ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxxxx

As per the error details, the generic reason for this error is not defining the linked service parameter but this error can arise when using same parameters for both Service principal ID and Secret name in the pipeline dynamic expression of the Azure KeyVault linked service. The documentation lacks the error details about the Azure KeyVault linked service. This request aims to offer a structured approach using the linked service parameters in Azure KeyVault linked service.

Correction Details:

This guide will allow users to:

Handle the above error when using Azure KeyVault linked service with parameters.

Steps:

1. Prerequisites:

Create the parameters in the Azure Keyvault linked service, parameterize the Service principal ID and Secret name in it. Use this linked service for any other linked service for the purpose of secret retrieval.

2. Reason for the above error:

The above error can occur for two reasons.

• A generic reason for this can be not defining the linked service parameter.

• When the same parameters are used for both Service principal ID and Secret name in the pipeline dynamic expression.

  

3. Steps to avoid this error:

• Making sure to use different parameters for the Service principal ID and Secret name or Use string interpolation @{} when using these parameters in the linked service.

  

Conclusion

By following this guide, users can avoid the parameter not defined error and can use Parameterized Azure KeyVault linked service effectively.

Reference:

https://stackoverflow.com/questions/79085888/how-to-parametrize-the-keyvault-secret-field-in-a-linked-service-using-function/79086418#79086418

This Correction request aims to improve user experience and security by providing clear documentation and example scripts to avoid the error in the Parameterized Azure KeyVault linked services.

[TPavanBalaji]

@GovindulaRakesh
Thanks for sharing the feedback. Since this channel is for driving improvements towards Docs, could you please provide the URL of the specific documentation that your feedback is applicable to? That way, we can make sure your feedback is addressed by the right team.