Skip to content

{webapp} Fix description of --identities parameter#25535

Open
SaurabhSharma-MSFT wants to merge 2 commits intoAzure:devfrom
SaurabhSharma-MSFT:webapp-fix
Open

{webapp} Fix description of --identities parameter#25535
SaurabhSharma-MSFT wants to merge 2 commits intoAzure:devfrom
SaurabhSharma-MSFT:webapp-fix

Conversation

@SaurabhSharma-MSFT
Copy link
Copy Markdown
Member

Related command
az webapp identity assign

Description
{webapp} Fix description of --identities parameter to mention passing the full qualified resource id.
Fixes GitHub Issue 25401

Testing Guide

History Notes

[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change
[Component Name 2] az command b: Add some customer-facing feature


This checklist is used to make sure that common guidelines for a pull request are followed.

@ghost ghost added the Auto-Assign Auto assign by bot label Feb 22, 2023
@ghost ghost assigned zhoxing-ms Feb 22, 2023
@ghost ghost added this to the Feb 2023 (2023-03-07) milestone Feb 22, 2023
@ghost ghost requested a review from yonzhan February 22, 2023 02:22
@ghost ghost added the Web Apps az webapp label Feb 22, 2023
@ghost ghost requested a review from wangzelin007 February 22, 2023 02:22
@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Feb 22, 2023

webapp

c.argument('role', help="Role name or id the managed identity will be assigned")
with self.argument_context(scope + ' identity assign') as c:
c.argument('assign_identities', options_list=['--identities'], nargs='*', help="Space-separated identities to assign. Use '{0}' to refer to the system assigned identity. Default: '{0}'".format(MSI_LOCAL_ID))
c.argument('assign_identities', options_list=['--identities'], nargs='*', help="Space-separated identities to assign. For User Assigned Identities, pass ids as full qualified resource ids like '/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName'. Use '{0}' to refer to the system assigned identity. For User Assigned Identities, pass ids as full qualified resource ids like '/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName'. Default: '{0}'".format(MSI_LOCAL_ID))
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I think adding help examples is better than adding too many descriptions directly in the help message

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zhoxing-ms Ok. got it. Do you want me to update the examples instead.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, exactly~

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zhoxing-ms Sounds good. I will update here once done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--identities parameter for 'az webapp identity assign' is not clearly documented

4 participants