Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SaurabhSharma-MSFT wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f27ee80
{webapp} Fix description of --identities parameter
SaurabhSharma-MSFT Feb 22, 2023
a335439
Rephrased the parameter description
SaurabhSharma-MSFT Feb 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/azure-cli/azure/cli/command_modules/appservice/_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,9 +287,9 @@ def load_arguments(self, _):
c.argument('scope', help="The scope the managed identity has access to")
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

@zhoxing-ms zhoxing-ms Mar 2, 2023

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

@SaurabhSharma-MSFT SaurabhSharma-MSFT Mar 3, 2023

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

@zhoxing-ms zhoxing-ms Mar 28, 2023

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

@SaurabhSharma-MSFT SaurabhSharma-MSFT Mar 28, 2023

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.

with self.argument_context(scope + ' identity remove') as c:
c.argument('remove_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('remove_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))

with self.argument_context(scope + ' deployment source config-zip') as c:
c.argument('src', help='a zip file path for deployment')
Expand Down Expand Up @@ -1100,9 +1100,9 @@ def load_arguments(self, _):
c.argument('scope', help="The scope the managed identity has access to")
c.argument('role', help="Role name or id the managed identity will be assigned")
with self.argument_context('staticwebapp 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. Default: '{0}'".format(MSI_LOCAL_ID))
with self.argument_context('staticwebapp identity remove') as c:
c.argument('remove_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('remove_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. Default: '{0}'".format(MSI_LOCAL_ID))
with self.argument_context('staticwebapp create') as c:
c.argument('location', arg_type=get_location_type(self.cli_ctx))
c.argument('tags', arg_type=tags_type)
Expand Down
Loading