Redis access-policy-assignment --object_id_alias parameter has incorrect documentation

AzureMarker commented 3 months ago

Describe the bug

The --object_id_alias parameter is documented as:

User friendly name for object id. Also represents username for token based authentication

Code: https://github.com/Azure/azure-cli/blob/0375c78714ee8d373f6ad590638a7ce0a81d3227/src/azure-cli/azure/cli/command_modules/redis/_params.py#L76-L77 Public docs: https://learn.microsoft.com/en-us/cli/azure/redis/access-policy-assignment?view=azure-cli-latest#az-redis-access-policy-assignment-create

However, it is not used as the username for token authentication. That's still the object ID.

Related command

redis access-policy-assignment create redis access-policy-assignment update

Errors

N/A

Issue script & Debug output

N/A

Expected behavior

Documentation should note that the object ID is the username, not the alias.

Environment Summary

azure-cli 2.61.0

core 2.61.0 telemetry 1.1.0

Extensions: arcappliance 1.0.2 azurestackhci 0.2.9 connectedk8s 1.6.7 connectedvmware 0.2.1 customlocation 0.1.3 k8s-extension 1.6.1 ssh 2.0.2

Dependencies: msal 1.28.0 azure-mgmt-resource 23.1.1

Python location '/usr/local/Cellar/azure-cli/2.61.0/libexec/bin/python' Extensions directory '/Users/mark/.azure/cliextensions' Development extension sources: /Users/mark/Projects/arcappliance-cli-extensions

Python (Darwin) 3.11.9 (main, Apr 2 2024, 08:25:04) [Clang 15.0.0 (clang-1500.3.9.4)]

Legal docs and information: aka.ms/AzureCliLegal

Your CLI is up-to-date.

Additional context

No response

yonzhan commented 3 months ago

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

microsoft-github-policy-service[bot] commented 3 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @shariq-mcs, @MSFTeegarden.

Azure / azure-cli