search

Azure / azure-cli

Azure Command-Line Interface
MIT License
4.03k stars 3.01k forks source link

Note clear what this command does and what options are used for. #10946

Open KevinGrealish opened 5 years ago

KevinGrealish commented 5 years ago

The text on this page is no clear for someone who is not already well versed in this command. Suggested updates that help clarify what this command does and what the options actually are.

"This command adds or changes the credentials that can be used by the service principal to log in. Credentials can be a certificate or a password." --password -p The password that the service principal will use to log in. In this case the password is the credential. --cert The certificate that the service principal will use to log in. When provided, will be the credential being set for the service principal. The certificate is specified as a file path and the accepted formats are ....

Document Details

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

jiasli commented 5 years ago

Good catch! We do have a long-summary in the source code:

https://github.com/Azure/azure-cli/blob/14b5a20839a9bc1f37d3c259564bce7546ef6478/src/azure-cli/azure/cli/command_modules/role/_help.py#L382-L385

https://github.com/Azure/azure-cli/blob/14b5a20839a9bc1f37d3c259564bce7546ef6478/src/azure-cli/azure/cli/command_modules/role/_help.py#L392-L394

But for some reason it is not exported to the public doc https://docs.microsoft.com/en-us/cli/azure/ad/sp/credential

Let us see how we can address this.

yonzhan commented 4 years ago

add to S171

yonzhan commented 4 years ago

add to backlog