How to update app config value against a key via APIM

Amit Srivastava 60

Hi Team, Can you please help me , how can I update an app config key- val via APIM? I need to make an operation/API in APIM to be able to update the value of an app config key. Thanks in Advance

1 answer

MuthuKumaranMurugaachari-MSFT 22,261 Reputation points

2023-04-11T19:41:34.02+00:00
Amit Srivastava Thanks for posting your question in Microsoft Q&A. You can create an API with Web service URL points to Azure App Configuration (`https://<appconfig-name>.azconfig.io) and add an operation for PUT method with template parameters as shown below (refer doc: Create an API).

Add a policy to get authorization token and set it in Authorization header before calling backend API and also set query parameter api-version. Follow other thread for the detailed instructions related to this.

<authentication-managed-identity resource="https://azconfig.io" ignore-error="false" output-token-variable-name="msi-access-token" /> <set-header name="Authorization" exists-action="override"> <value>@("Bearer " + (string)context.Variables["msi-access-token"])</value> </set-header> <set-query-parameter name="api-version" exists-action="override"> <value>1.0</value> </set-query-parameter>

While calling API, make sure you set content type as application/vnd.microsoft.appconfig.kv+json and pass the request body in the format specified in Set key API. Note, the above code snippet is a sample policy for your reference. If you face any issues, let me know. I hope this helps with your question.

If you found the answer to your question helpful, please take a moment to mark it as "Yes" for others to benefit from your experience. Or simply add a comment tagging me and would be happy to answer your questions.
Please sign in to rate this answer.
Amit Srivastava 60 Reputation points

2023-04-12T17:20:37.18+00:00

Hi Muthukumaran, I tried the approach you mentioned but unfortunately it did not went well. Steps I followed are as follows. 1. Created an operation at APIM to call the API to update the app config value to Y. 2. Make a call to Azure AD to get token to be use for azconfig app config value update against the key. 3. Finally making call to azconfig with request body as json having only the value example : { "value" : "Y"}. Please note error that I am getting is " backend call is timed out". Also if you could help me with sample code here. The requirement is to expose an endpoint by hitting which app config key value can be updated. Thanks Much.

MuthuKumaranMurugaachari-MSFT 22,261 Reputation points

2023-04-12T17:48:53.9066667+00:00

Amit Srivastava This set up is what I have in my APIM and validated it works.

Can you share the screenshot of how you defined the operation? The first screenshot Frontend is how you define a PUT operation with template parameters and endpoint will be like https://<apim-name>.azure-api.net/apptest/kv/{key}?label=%2500.

I use the above policy snippet in the inbound section and here is the screenshot reference (make sure to set up access for managed identity):

Here is the sample request I have tested via portal console.

Hope you defined backend API as https://<appconfig-name>.azconfig.io and make sure if it is accessible from APIM (if deployed in VNET, check NSG and firewall rules). Based on the error, it seems there is an issue with the connectivity to App Config endpoint and suggest you review the traces/exception.

MuthuKumaranMurugaachari-MSFT 22,261 Reputation points

2023-04-14T15:32:24.0933333+00:00

Amit Srivastava If you still have any question, let me know. If you found the answer helpful, please consider marking it as "Yes".

Amit Srivastava 60 Reputation points

2023-04-18T10:52:14.97+00:00

Hi MuthuKumaran, Issue still not fixed. Getting backend api connection timeout. However I have one other api to retrieve the key value from app config and that is working fine, but this one is to modify the value of an existing key which is not working. Please note I have followed the same approach as you mentioned above and also I checked the Role part which is App Data Owner, so I believe I should be able to update the key. Same is working fine if executed through POST MAN but not working when doing via APIM. Please help here. Thanks

Amit Srivastava 60 Reputation points

2023-04-18T12:13:54.35+00:00

Screenshot of my policy for your reference.

MuthuKumaranMurugaachari-MSFT 22,261 Reputation points

2023-04-18T14:38:43.4833333+00:00

Amit Srivastava Other API that is working fine is defined in the same APIM instance or different APIM? Can you confirm the backend URL you have configured with the API is https://<appconfig-name>.azconfig.io (with URL as mentioned above)? I suggest you capture Trace a call and validate if the backend URL and headers are set correctly. If you can share correlation ID/request ID, I can check the logs for the cause.

Amit Srivastava 60 Reputation points

2023-04-19T10:40:55.6166667+00:00

Hi Muthukumaran, yes it is on the same APIM instance. Tracing is not possible at my end, but I checked the APIM logs and can validate from error response that the BackendUrl which is getting formed is correct having "<appconfiginstance>.azconfig.io/kV/<keyname>?api-version=1.0".

MuthuKumaranMurugaachari-MSFT 22,261 Reputation points

2023-04-19T13:34:18.7266667+00:00

Amit Srivastava We would need to review the backend logs for this specific APIM instance and find the cause. You can send an email to azcommunity@microsoft.com referencing this thread with your subscription ID, APIM instance name, error details, timestamp and subject as "Attn: Muthu". I will assist you offline with next steps.
Sign in to comment

Share via

How to update app config value against a key via APIM

1 answer