APP config exporting key value pairs limitaion

Hey Team.
Basically, I am working on exporting Key value pairs from my appconfig on azure .
so this is my command I have been implementing to export .
az appconfig kv export -n myappconfig-list1-demo -d file --path ./test123.yaml --prefix "/a/lab1234/" --separator "." --key "/a/lab1234/configmap.app.name","/a/lab1234/configmap.server.port","/a/lab1234/configmap.highq.multitenant.datasource.connections.default.url","/a/lab1234/deployment.hostname","/a/lab1234/deployment.istioGateway","/a/lab1234/configmap.server.servlet.context-path","/a/lab1234/configmap.hub.url" --format yaml -y --resolve-keyvault

Instead of exporting all the key value pairs in the concerned list, I am just exporting which ever required for my current task, and i am mentioning multiple keys pairs in --key separated by comma (,).

So my concern here is , I am able to export them correctly with 5 keypairs, if i add one more to the list , its failing with the error : Operation returned an invalid status 'Bad Request'

Is there is any limit to the key pairs values while exporting using az appconfig kv export process.
I havnt find any supporting document for this regarding this., so i would appreciate response in this concern.

Thanks in advance.

Accepted answer

MuthuKumaranMurugaachari-MSFT 22,341 Reputation points

2023-08-30T13:29:26.14+00:00

Bodavula Sai Vamsi Mohan Krishna Thanks for posting your question in Microsoft Q&A. Currently, the name filtering for keys is limited to 5 comma-separated values (CSV), and it is documented in Filtering Rest API doc. CLI command az appconfig kv export uses this rest api and hence the same limitation applies. You can consider using * to match any prefix or running repeatedly as suggested by Deepanshu katara.

I will pass the feedback to our doc team for adding this note, however, you can also submit it via Feedback at the bottom of the page (az-appconfig-kv-export doc). I hope this helps and let us know if any questions.

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.

1 person found this answer helpful.
Bodavula Sai Vamsi Mohan Krishna 20 Reputation points

2023-08-31T08:33:36.1333333+00:00

Hey Hai, Deepanshu katara.

I appreciate your time and resposne.

I like the way/ approach you have mentioned.But wrt to the currrent scenario., we have a drawaback of dividing keypairs in two commands as part of export process.

Issue here ,as mentioned, I need to export & key pairs (suppose) . I will add first 4 in an az(command) and next three in second command. as mentioned in ticket, its trying to export 7 key value pairs into a single output file., the values obtained in the first command are over written the vales that are objained in the second command, valinishing all athe values that are writtten in previous Command.

If i tried to append them using a dummy file, its creating another configuration in the yaml file.,

Bodavula Sai Vamsi Mohan Krishna 20 Reputation points

2023-09-11T08:03:23.3633333+00:00

Hey Hai., @MuthuKumaranMurugaachari-MSFT

I just have a concern., any idea about exporting the keys., with excluding some keys.,

suppose., if I have some 10 Keys in my app config., in my configmap., and i just want to exclude 3-4 keys., which are supersecrets., so., is there any way, we can tried them excluding while export process.

i tried using --query , but not working., instead asking for extra roles., where the same roles worked fine for normal exporting keys process.

workaround:
az appconfig kv export -n eastus2-highq-lab-appconfig -d file --path ./test12yaml --prefix /a/lab1sever1/ --separator "." --query "[?key!='/a/a/lab1sever1/ configmap.app.name']" --format yaml -y --resolve-keyvault

az appconfig kv list --name eastus2-highq-lab-appconfig --output json --query "[?key!='/a/lab1sever1/ configmap.app.name']" | jq 'map({(select(.contentType=="secret").key): .value, (select(.contentType!="secret").key): .value}) | add' > exported_keys.json

az appconfig kv list --name eastus2-highq-lab-appconfig --prefix /a/lab1sever1/ --query "[?contains(key, '/a/lab1sever1/ configmap.app.name') == `false`]" --output json --all | tee exported_keys.json

az appconfig kv export -n eastus2-highq-lab-appconfig -d file --path ./test.yaml --prefix "/a/lab1sever1/ " --separator "." --query "[?key!='/a/lab1authserver1zus1/configmap.app.name']" --format yaml --yes --resolve-keyvault

None of these are working.

apconfig list is running , but giving null values.

Any idea on this.
I would appreciate your quick response.!

Thanks in advance.!

MuthuKumaranMurugaachari-MSFT 22,341 Reputation points

2023-09-11T14:02:39.8733333+00:00

Bodavula Sai Vamsi Mohan Krishna Quickly checking, I am able to use --query to exclude the values with az appconfig kv list -n <appservice> --query "[?key!='/sub1/rg2'].{key:key, value:value}". However, it doesn't seem to work for az appconfig kv export -n <appservice> -d file --path /test.json --format json --query "[?key!='/sub1/rg1']" in my test.

Will investigate further and let you know.

MuthuKumaranMurugaachari-MSFT 22,341 Reputation points

2023-09-11T19:12:03.0833333+00:00

Bodavula Sai Vamsi Mohan Krishna The --query parameter is a global parameter in CLI and only applies to the displayed output. Hence, this is not applicable to export command the way you expect. However, in my test list command should work fine as below:

Key values:

Output

az appconfig kv list -n <name> --query "[?key!='/sub1/rg2'].{key:key, value:value}" [ { "key": ".appconfig.featureflag/Beta", "value": "{\"id\":\"Beta\",\"description\":\"\",\"enabled\":false,\"conditions\":{\"client_filters\":[]}}" }, { "key": "/sub1/rg1", "value": "Test" } ]

If you still face the issue, I suggest applying the filter conditions one by one in your environment (after listing all) and validate the query.

Currently, you can filter the matches only based on --key with some prefix value or --label (if applicable for your scenario) in export command.

Bodavula Sai Vamsi Mohan Krishna 20 Reputation points

2023-09-12T06:50:22.56+00:00

Hey Hai @MuthuKumaranMurugaachari-MSFT
Thanks for the response.

Yeah was able to list by applying excluding keys.
but ., its listing entire keys in the app config., suppose if i have some N number of keys with different prefixes., its listing all .Where as adding prefix to the query is not supported While using **List.
**
while using export., its expecting more permissions : //(Forbidden) The user, group or application 'appid=xxxxxxxxxx;oid=yyyyyyyyyy;numgroups=1;iss=https://sts.windows.net/zzzzzzz/' does not have secrets get permission on key vault 'eastus2Xyxxyx;location=eastus2'. For help resolving this issue, please see https://go.microsoft.com/fwlink/?linkid=2125287

MuthuKumaranMurugaachari-MSFT 22,341 Reputation points

2023-09-12T15:10:55.5966667+00:00

Bodavula Sai Vamsi Mohan Krishna if you are looking to apply some prefix, you can do that too with --key parameter.

az appconfig kv list -n mkappconfig --key "/sub1*" --query "[?key!='/sub1/rg2'].{key:key, value:value}" [ { "key": "/sub1/rg1", "value": "Test" } ]

Check out doc az appconfig kv list for more info. The export command cannot be used in your scenario.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

1 additional answer

Deepanshukatara-6769 10,455 Reputation points

2023-08-30T06:55:56.95+00:00
Hope you are having good day

Indeed, command-line arguments do have a length limit, and that might be a potential reason for the "Bad Request" error you're encountering. When you provide a long list of keys as arguments to a command, the total length of those arguments might exceed the operating system's command-line length limit.

To address this issue, you can try the following approaches:

Split into Multiple Commands: Instead of providing all the keys in a single command, you can split them into multiple commands, each exporting a subset of the keys. This way, you avoid hitting the command-line length limit.

bashCopy code az appconfig kv export -n myappconfig-list1-demo ... --key "key1","key2","key3" -y --resolve-keyvault az appconfig kv export -n myappconfig-list1-demo ... --key "key4","key5","key6" -y --resolve-keyvault

Adding to this The idea I mentioned about splitting into multiple commands is a manual approach you can take to avoid command-line length limits. It involves running the same az appconfig kv export command multiple times, each time specifying a subset of the key-value pairs to export. This approach doesn't have an official Microsoft documentation page because it's not a standardized feature or option of Azure CLI.

if it helps you please accept answer , Thanks
Please sign in to rate this answer.
Bodavula Sai Vamsi Mohan Krishna 20 Reputation points

2023-08-31T08:33:12.6466667+00:00

Hey Hai, Deepanshu katara.

I appreciate your time and resposne.

I like the way/ approach you have mentioned.But wrt to the currrent scenario., we have a drawaback of dividing keypairs in two commands as part of export process.

Issue here ,as mentioned, I need to export & key pairs (suppose) . I will add first 4 in an az(command) and next three in second command. as mentioned in ticket, its trying to export 7 key value pairs into a single output file., the values obtained in the first command are over written the vales that are objained in the second command, valinishing all athe values that are writtten in previous Command.

If i tried to append them using a dummy file, its creating another configuration in the yaml file.,
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

APP config exporting key value pairs limitaion

1 additional answer

Your answer