[Key vault] Encrypt with latest key version if not specified

[lzhecheng]

Feature Request

Currently in the public doc, key-version is required for encryption. Is it possible that we can get rid of key-version and use the latest key-version when encryption? I found that with the 2016-10-01 api-version, it works.

[gracewilcox]

Hi @lzhecheng! I'm assuming you're using our azkeys module. If so, you can just pass in the empty string into the version parameter, and the service will default to using the latest key version.

[github-actions]

Hi @lzhecheng. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

[lzhecheng]

@gracewilcox thank you for the reply! It is very helpful!
I got this question because here it says version is required. So I am confused. Should this doc be updated as well? Thanks!
https://learn.microsoft.com/en-us/rest/api/keyvault/keys/encrypt/encrypt?view=rest-keyvault-keys-7.4&tabs=HTTP#uri-parameters

[lzhecheng]

I mean when I encrypt() without key version here

[gracewilcox]

Hi @lzhecheng! The key vault key version is a bit of a special case, so that's why it's not as clearly documented. But if you're using our Client.Encrypt() method and pass in the empty string, the service will use the latest version of the key.

Hope that helps! :)

[lzhecheng]

@gracewilcox Really appreciate it! The reason I asked about the Public doc is that I will use the api in our service so hope that we can have it officially mentioned in the doc, and this will not change in the future.
Is it possible we can make it? Thanks!

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @jlichwa @RandalliLama @schaabs.

[gracewilcox]

Hi lzhecheng! Docs are controlled by the service team, so routing you to them.