Share via


az containerapp env identity

Note

This reference is part of the containerapp extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az containerapp env identity command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage environment managed identities.

Commands

Name Description Type Status
az containerapp env identity assign

Assign managed identity to a managed environment.

Extension Preview
az containerapp env identity remove

Remove a managed identity from a managed environment.

Extension Preview
az containerapp env identity show

Show managed identities of a managed environment.

Extension Preview

az containerapp env identity assign

Preview

Command group 'containerapp env identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Assign managed identity to a managed environment.

Managed identities can be user-assigned or system-assigned.

az containerapp env identity assign [--ids]
                                    [--name]
                                    [--no-wait]
                                    [--resource-group]
                                    [--subscription]
                                    [--system-assigned]
                                    [--user-assigned]

Examples

Assign system identity.

az containerapp env identity assign -n my-env -g MyResourceGroup --system-assigned

Assign user identity.

az containerapp env identity assign -n my-env -g MyResourceGroup --user-assigned myUserIdentityName

Assign user identity (from a different resource group than the managed environment).

az containerapp env identity assign -n my-env -g MyResourceGroup --user-assigned myUserIdentityResourceId

Assign system and user identity.

az containerapp env identity assign -n my-env -g MyResourceGroup --system-assigned --user-assigned myUserIdentityResourceId

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Container Apps environment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--system-assigned
Preview

Boolean indicating whether to assign system-assigned identity.

Default value: False
--user-assigned
Preview

Space-separated user identities.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az containerapp env identity remove

Preview

Command group 'containerapp env identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a managed identity from a managed environment.

az containerapp env identity remove [--ids]
                                    [--name]
                                    [--no-wait]
                                    [--resource-group]
                                    [--subscription]
                                    [--system-assigned]
                                    [--user-assigned]

Examples

Remove system identity.

az containerapp env identity remove -n my-env -g MyResourceGroup --system-assigned

Remove user identity.

az containerapp env identity remove -n my-env -g MyResourceGroup --user-assigned myUserIdentityName

Remove system and user identity (from a different resource group than the containerapp).

az containerapp env identity remove -n my-env -g MyResourceGroup --system-assigned --user-assigned myUserIdentityResourceId

Remove all user identities.

az containerapp env identity remove -n my-env -g MyResourceGroup --user-assigned

Remove system identity and all user identities.

az containerapp env identity remove -n my-env -g MyResourceGroup --system-assigned --user-assigned

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Container Apps environment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--system-assigned
Preview

Boolean indicating whether to assign system-assigned identity.

Default value: False
--user-assigned
Preview

Space-separated user identities. If no user identities are specified, all user identities will be removed.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az containerapp env identity show

Preview

Command group 'containerapp env identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show managed identities of a managed environment.

az containerapp env identity show [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Show managed identities.

az containerapp env identity show -n my-env -g MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Container Apps environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.