Expand Azure CLI documentation for az storage account create and update ...

[bdcoder2]

Related command

• az storage account create

Is your feature request related to a problem? Please describe.
Yes - the existing documentation was lacking and I spent several days trying to figure out how to accomplish a (simple) task before posting a question on StackOverflow.

Describe the solution you'd like

With regard to the az storage account update command:

I would like to see additional details added to the --set parameter. Specifically, the current documentation states:

Update an object by specifying a property path and value to set. Example: --set property1.property2=.
default value: []

As a newbie to Azure storage, reading the above only creates more questions, for example:

1. "Update an object" -- which object? I am assuming the storage account object?
2. "... specifying a property path and value to set" -- WHAT are the property names and their accepted values? Ideally a list of property names and valid values for each should be listed. Or provide a means of doing so.

By expanding the existing "description" of the parameter, it would be much clearer on what the --set parameter can in fact set

With regard to the az storage account create command:

The Azure documentation makes several references to using Microsoft Entra authorization to access resources and even suggests doing so rather than using access keys. I was assuming I would find a CLI command option on the az storagea ccount create command such as:

--EnableMicrosoftEntra true

... but behold - no such pararameter option exists -- instead, one must first create astorage account, and the modify it -- as per the answer posted on StackOverflow.

I hope these suggestions will be considered - it should help other "newbies" like myself.

Describe alternatives you've considered
Tried using Azure PowerShell -- but the documentation was lacking in that area as well.

Additional context
Please see my question as posted on StackOverflow: https://stackoverflow.com/questions/77511961

[yonzhan]

Thank you for opening this issue, we will look into it.

[calvinhzy]

Hi @bdcoder2 for the --set param, it is part of our generic update command parameters where some of the parameter might not be exposed by default and users can still update using this command, so we are intentionally keeping the help info comprehensive. You can use the show command to see which parameter you can update with --set https://learn.microsoft.com/en-us/cli/azure/use-cli-effectively?tabs=bash%2Cbash2#generic-update-parameters
We will look into adding something like --enable-microsoft-entra or --default-to-oauth to both create/update commands after we go through the security considerations. Thanks for your input.

[jiasli]

I would like to see additional details added to the --set parameter. Specifically, the current documentation states:

Update an object by specifying a property path and value to set. Example: --set property1.property2=.
default value: []

FYI, there is some rendering issue with generic update arguments' documentation. We are fixing it in #27752.

[jiasli]

Regarding this comment from https://stackoverflow.com/a/77513665/2199657

I was looking for an option at the time of creation, via the "az storage account create" command. I did look at the "az storage account update" command as well, but it is NOT very intuitive to use the --set option as the MS docs do not include any information on WHICH options can be set.

I previously proposed a --parameters argument in #23490. --parameters argument can be added to any create or update command. It takes a JSON that is merged into the serialized object (e.g. /providers/Microsoft.Storage/storageAccounts) generated by the command (e.g. az storage account create).

If that proposal is adopted, we can do something like this to set properties (e.g. defaultToOAuthAuthentication) not exposed by Azure CLI commands:

az storage account create ... --parameters '{"defaultToOAuthAuthentication": true}'

[bdcoder2]

@jiasli - I would agree, the addition of a --parameters argument could greatly simply the CLI. In fact, one could take it a step further, something along the line of:

az command <--required-parameters '{...}'> [--optional-parameters '{...}']

For example:

az storage account create \
   --required-parameters '{ "name": mystorage, "resource-group": "myresourcegroup" }'   \
   --optional-parameters '{ "defaultToOAuthAuthentication": true, "sku": "Standard_RAGRS" }'

Every CLI command would only require the two parameters above to set any required or optional properties.

The documentation could then show the JSON (properties) for an object (such as a storage account) and mark those properties that are required and those that are optional. Of course, the valid values for each property would need to be shown as well.