-
Notifications
You must be signed in to change notification settings - Fork 3k
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.
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
{Profile} Update help message for arguments #30090
Conversation
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
az login refinement |
def load_arguments(self, command): | ||
from azure.cli.core.api import get_subscription_id_list | ||
|
||
with self.argument_context('login') as c: | ||
c.argument('password', options_list=['--password', '-p'], help="Credentials like user password, or for a service principal, provide client secret or a pem file with key and public certificate. Will prompt if not given.") | ||
c.argument('service_principal', action='store_true', help='The credential representing a service principal.') | ||
c.argument('username', options_list=['--username', '-u'], help='user name, service principal, or managed service identity ID') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"service principal" is a resource. It should be "service principal client ID".
help='Credentials like password for user, or for a service principal, provide client ' | ||
'secret or a PEM file with key and public certificate. Will prompt if not given.') | ||
c.argument('tenant', options_list=['--tenant', '-t'], validator=validate_tenant, | ||
help='The Microsoft Entra tenant, must provide when using a service principal.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed from "AAD" to "Microsoft Entra".
c.argument('use_device_code', action='store_true', | ||
help="Use CLI's old authentication flow based on device code. CLI will also use this if it can't launch a browser in your behalf, e.g. in remote SSH or Cloud Shell") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Device code is a currently support flow. It is not "old".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"In your behalf" is wrong. It should be "on your behalf", but this phrase is not needed at all.
|
||
# Service principal | ||
c.argument('service_principal', action='store_true', | ||
help='Log in with a service principal.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed from "The credential representing a service principal." to make it more readable.
help='Use Subject Name Issuer (SN I) authentication in order to support automatic ' | ||
'certificate rolls.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the official name "Subject Name Issuer (SN I)".
|
||
# Managed identity | ||
c.argument('identity', options_list=('-i', '--identity'), action='store_true', | ||
help="Log in using managed identity", arg_group='Managed Identity') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed from "Log in using the Virtual Machine's identity". CLI not only supports Virtual Machine's managed identity, but also App Service and other services' managed identities as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed arg_group
from "Managed Service Identity" to "Managed Identity".
|
||
with self.argument_context('logout') as c: | ||
c.argument('username', help='account user, if missing, logout the current active account') | ||
c.ignore('_subscription') # hide the global subscription parameter | ||
|
||
with self.argument_context('account') as c: | ||
c.argument('subscription', options_list=['--subscription', '-s', '--name', '-n'], arg_group='', help='Name or ID of subscription.', completer=get_subscription_id_list) | ||
c.argument('subscription', options_list=['--subscription', '-s', '--name', '-n'], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An empty arg_group
is meaningless.
c.argument('resource_type', get_enum_type(cloud_resource_types), options_list=['--resource-type'], | ||
help='Type of well-known resource.') | ||
c.argument('resource', options_list=['--resource'], | ||
help='Azure resource endpoints in Microsoft Entra v1.0.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed from "AAD" to "Microsoft Entra".
c.argument('resource', options_list=['--resource'], | ||
help='Azure resource endpoints in Microsoft Entra v1.0.') | ||
c.argument('scopes', options_list=['--scope'], nargs='*', | ||
help='Space-separated scopes in Microsoft Entra v2.0. Default to Azure Resource Manager.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed from "AAD" to "Microsoft Entra".
help='Space-separated scopes in Microsoft Entra v2.0. Default to Azure Resource Manager.') | ||
c.argument('tenant', options_list=['--tenant', '-t'], | ||
help='Tenant ID for which the token is acquired. Only available for user and service principal ' | ||
'account, not for managed identity or Cloud Shell account') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed from "MSI" to "managed identity".
c.argument('tenant', options_list=['--tenant', '-t'], help='The AAD tenant, must provide when using service principals.', validator=validate_tenant) | ||
c.argument('allow_no_subscriptions', action='store_true', help="Support access tenants without subscriptions. It's uncommon but useful to run tenant level commands, such as 'az ad'") | ||
c.argument('username', options_list=['--username', '-u'], | ||
help='User name, service principal client ID, or managed identity ID.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed from "managed service identity" to "managed identity".
help="Support accessing tenants without subscriptions. It's uncommon but useful to run " | ||
"tenant-level commands, such as 'az ad'.") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed from "Support access tenants" to "Support accessing tenants" to fix the wrong grammar.
Changed from "tenant level commands" to "tenant-level commands".
c.argument('resource', options_list=['--resource'], help='Azure resource endpoints in AAD v1.0.') | ||
c.argument('scopes', options_list=['--scope'], nargs='*', help='Space-separated AAD scopes in AAD v2.0. Default to Azure Resource Manager.') | ||
c.argument('tenant', options_list=['--tenant', '-t'], help='Tenant ID for which the token is acquired. Only available for user and service principal account, not for MSI or Cloud Shell account') | ||
c.argument('resource_type', get_enum_type(cloud_resource_types), options_list=['--resource-type'], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An empty arg_group
is meaningless.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor comments on my side
Related command
az login
Description
Update help message for arguments, mainly including
az ad
: Rename Azure Active Directory to Microsoft Entra ID #27756Testing Guide
az login -h