ADF REST API Auth header parameters not showing up in other environments which are not connected to Git

Swati B 0 Reputation points
2024-10-09T00:12:06.29+00:00

We have two ADF instances - dev and production. Our dev environment is connected to Git repository, however when we move code to production, we only move ARM template files. We are observing that auth header parameters in REST API are not showing up in production environment. If we try to manually add parameters under Manage tab, parameters are lost after refreshing. Please advise.

Azure Data Factory
Azure Data Factory
An Azure service for ingesting, preparing, and transforming data at scale.
{count} votes

2 answers

Sort by: Most helpful
  1. Pinaki Ghatak 5,690 Reputation points Microsoft Employee Volunteer Moderator
    2024-10-09T08:38:05.7866667+00:00

    Hello @Swati B

    It seems like the issue is related to the global parameters not being included in the ARM template during the CI/CD process.

    When you move the ARM template files to the production environment, the global parameters are not included in the ARM template, which is causing the auth header parameters to not show up in the production environment.

    To resolve this issue, you can include the global parameters in the ARM template during the CI/CD process. You can do this by going to the "Manage hub" -> "ARM template" -> "Include global parameters in ARM template" in the Azure Data Factory UX.

    This will ensure that the global parameters are included in the ARM template and will be available in the production environment.

    If you are using the older mechanism (from 'Manage hub' -> 'Global parameters' -> 'Include in ARM template'), you can continue to use it.

    We will continue to support it. However, we strongly recommend using the new mechanism of including global parameters in the ARM template (from 'Manage hub' -> 'ARM template' -> 'Include global parameters in an ARM template') since it makes the CI/CD with global parameters much more straightforward and easier to manage.


    I hope that this response has addressed your query and helped you overcome your challenges. If so, please mark this response as Answered. This will not only acknowledge our efforts, but also assist other community members who may be looking for similar solutions.


  2. phemanth 15,855 Reputation points Microsoft External Staff Moderator
    2024-10-14T06:46:46.96+00:00

    @Swati B

    Thanks for more information further check the below steps and confirm us :

    Validation Errors on ARM Export: If you’re getting validation errors when exporting the ARM template from the higher environment, check the error messages closely. please provide the error message

    Parameter Persistence: Since the parameters are not saving in the production environment, consider checking if there are any policies or restrictions in place that might prevent saving changes. Sometimes, permissions or role assignments can affect this.

    CI/CD Pipeline Investigation: If you’re unable to find where the parameters are being set in the CI/CD pipeline, try looking for:

    • Variable Groups: These can store values that are used across multiple pipelines.
    • Pipeline Triggers: Ensure that the correct parameters are being passed during the deployment process.
    • Logs: Review the logs of the pipeline runs to see if there are any warnings or errors related to parameter handling.

    Since you mentioned the JSON configuration for the API in both environments, compare the two closely. Look for differences in:

    • authenticationType
    • authHeaders
    • Any other properties that might affect connectivity.

    To troubleshoot the unsuccessful API calls, consider using tools like Postman or curl to manually test the API with the same parameters. This can help determine if the issue lies within ADF or the API itself.

    If these steps don’t resolve the issue, please do let us know

    0 comments No comments

Your answer

Answers can be marked as 'Accepted' by the question author and 'Recommended' by moderators, which helps users know the answer solved the author's problem.