Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Value should be set as required #17461

Closed
gsuttie opened this issue Mar 25, 2021 · 3 comments · Fixed by #17553
Closed

Value should be set as required #17461

gsuttie opened this issue Mar 25, 2021 · 3 comments · Fixed by #17553
Assignees
Labels
KeyVault az keyvault question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@gsuttie
Copy link

gsuttie commented Mar 25, 2021

[Enter feedback here]
The docs say that for creating a keyvault secret that the -value isnt required but it is required.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@ghost ghost added needs-triage This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Mar 25, 2021
@yungezz yungezz added the KeyVault az keyvault label Mar 26, 2021
@ghost ghost removed the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 26, 2021
@yungezz
Copy link
Member

yungezz commented Mar 26, 2021

hi @BigCat20196 could you pls help to have a look? thanks

@BigCat20196
Copy link
Contributor

BigCat20196 commented Mar 29, 2021

hi @gsuttie The docs say that for creating a keyvault secret that -value isn required is because the parameter '--value' or '--file' can be selected in the optional parameter description, and they cannot exist simultaneously.
I guess when you use the 'az keyvault secret set' command and only enter the parameters ' -- name ' and '-- vault name', an error statement like 'incorrect usage: [Required] - value | - file path' appears. It makes you feel uncomfortable.
So what form do you want to upgrade the document to help us read and understand the use of commands?Please give us your upgrade advice. We are very grateful.

@gsuttie
Copy link
Author

gsuttie commented Mar 29, 2021

Hi There

I think it needs to be a little clearer, if you try this

az keyvault secret set --name $secretname --vault-name $keyvaultName

It doesnt work so it needs to be pointed out that you should supply a --value or --file.

I see the same issue with az keyvault secret show if you dont supply a --vault-name

I think some examples of each should be included in the docs so that its clearer that in some instances if lets say you dont know the --id then you need to supply the --vault-name.

BigCat20196 added a commit that referenced this issue Apr 6, 2021
)

* Update keyvault/_help

* Update keyvault/_help

* add a required parameters for second example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
KeyVault az keyvault question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants