[Key Vault] az keyvault: Revise --id argument help text#20369
Merged
[Key Vault] az keyvault: Revise --id argument help text#20369
Conversation
**Description** For commands that use the `--id` argument to identify the vault/HSM, the vault/HSM's full URI, like `https://vault-name.vault.azure.net/`, needs to be passed, not the resource's ARM ID, like `/subscriptions/.../resourceGroups/.../providers/Microsoft.KeyVault/vaults/vault-name`. Refine the argument help text to use "Full URI" instead of "Id" to try to minimize confusion. **Testing Guide** This only changes help text. No functionality should be affected. Fixes Azure#17399
Member
Author
|
Based on the discussion in issue #17399, "az keyvault certificate list --id", it appears that operations on the vault/HSM that have an |
Collaborator
|
Key Vault |
evelyn-ys
approved these changes
Nov 17, 2021
Member
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
jiasli
reviewed
Nov 17, 2021
| if cmd in ['list']: | ||
| c.extra('identifier', options_list=['--id'], | ||
| help='Id of the Vault or HSM. ' | ||
| help='Full URI of the Vault or HSM. ' |
Member
There was a problem hiding this comment.
Personally I think it is anti-convention to name it "URI" in Azure Portal (#17399 (comment)), given it has https:// prefix.
This was discussed previously at #13067.
Also see https://danielmiessler.com/study/difference-between-uri-url/
If the protocol (https, ftp, etc.) is either present or implied for a domain, you should call it a URL—even though it’s also a URI.
jiasli
approved these changes
Nov 17, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
For commands that use the
--idargument to identify the vault/HSM, thevault/HSM's full URI, like
https://vault-name.vault.azure.net/, needsto be passed, not the resource's ARM ID, like
/subscriptions/.../resourceGroups/.../providers/Microsoft.KeyVault/vaults/vault-name.Refine the argument help text to use "Full URI" instead of "Id" to try
to minimize confusion.
Testing Guide
This only changes help text. No functionality should be affected.
Fixes #17399
This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.