-
Notifications
You must be signed in to change notification settings - Fork 3.5k
{Doc} Add managed identity command guideline #17473
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
Changes from 3 commits
b8659f2
b3a8fea
e6b366a
b79fde1
4d10825
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| ## Overview | ||
| This document provides a common design of the CLI command interface for supporting Managed Identity in Azure CLI. New commands should follow it while existing commands can stay the same before a deprecation plan. | ||
|
|
||
| ## Command interface | ||
|
|
||
| ### Enable managed identity during resource creation | ||
| Use `--mi-system-assigned` to enable system-assigned identity and `--mi-user-assigned` with space separated resource IDs to add user-assigned identities. | ||
|
|
||
| ``` | ||
| # <resource> can be acr, webapp, vm or any other resources that support managed identity | ||
| az <resource> create ... --mi-system-assigned --mi-user-assigned <AzureResourceId1> <AzureResourceId2> | ||
| ``` | ||
|
|
||
| ### Operate managed identity on existing resource | ||
| Create the `identity` subgroup under the main resource command group. Support the below operations: | ||
|
|
||
| 1. Assign identities with `identity assign` command | ||
|
|
||
| Use `--system-assigned` to enable system assigned identity and `--user-assigned` with space separated recource ids to add user assigned identities. | ||
| ``` | ||
| az <resource> identity assign ... --system-assigned --user-assigned <AzureResourceId1> <AzureResourceId2> | ||
| ``` | ||
| 2. Remove identities with `identity remove` command | ||
|
|
||
| Use `--system-assigned` to remove system assigned identity and `--user-assigned` with space separated resource ids to remove user assigned identities. | ||
| ``` | ||
| az <resource> identity remove ... --system-assigned --user-assigned <AzureResourceId1> <AzureResourceId2> | ||
| ``` | ||
| 3. Show identities with `identity show` command | ||
|
|
||
| Use this command to show the managed identity type, tenant ids and principal ids of the system assigned identities and all user assigned identities. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. With system assigned identities and all user assigned identities, Why it's named
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good question. The result is not a list. It contains the principal id, tenant id for the system assigned identity, identity type and a dict of user assigned identities. Naming it to |
||
| ``` | ||
| az <resource> identity show ... | ||
| ``` | ||
| 4. Update identities with `identity update` command | ||
|
|
||
| Use different identity types to do the following: | ||
| - Remove all assigned identities | ||
| ``` | ||
| az <resource> identity update ... --type none | ||
| ``` | ||
| - Remove all user assigned identities if exist and enable system assigned identity if not enabled | ||
| ``` | ||
| az <resource> identity update ... --type system_assigned | ||
| ``` | ||
| - Remove system assigned identities only when both system assigned and user assigned identities exist | ||
|
fengzhou-msft marked this conversation as resolved.
Outdated
|
||
| ``` | ||
| az <resource> identity update ... --type user_assigned | ||
| ``` | ||
|
fengzhou-msft marked this conversation as resolved.
Outdated
|
||
Uh oh!
There was an error while loading. Please reload this page.