Skip to content

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

@AzureMarker

Description

@AzureMarker

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:

c.argument('object_id_alias', help='User friendly name for object id. Also represents username for token '
'based authentication')

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Redis CacheService AttentionThis issue is responsible by Azure service team.act-codegen-extensibility-squadbugThis issue requires a change to an existing behavior in the product in order to be resolved.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions