Share via

az image builder identity

  • Reference

Manage identities of an image builder template.

Commands

Name Description Type Status
az image builder identity assign

Add managed identities to an existing image builder template. Currently, only one user identity is supported.

 Core GA
az image builder identity remove

Remove managed identities from an existing image builder template.

 Core GA
az image builder identity show

Display managed identities of a image builder template.

 Core GA

az image builder identity assign

Add managed identities to an existing image builder template. Currently, only one user identity is supported.

az image builder identity assign [--defer]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--user-assigned]

Examples

Add a user assigned managed identity to an existing image builder template.

az image builder identity assign --name MyImageBuilderTemplate --resource-group MyResourceGroup --user-assigned MyAssignedId

Optional Parameters

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--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

The name of the image template.

--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.

--user-assigned

Specify one user assigned identity (name or ID, space delimited) of the image template.

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 image builder identity remove

Remove managed identities from an existing image builder template.

az image builder identity remove [--defer]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--user-assigned]
                                 [--yes]

Examples

Remove a user assigned managed identity from an existing image builder template.

az image builder identity remove --name MyImageBuilderTemplate --resource-group MyResourceGroup --user-assigned MyAssignedId

Remove all user assigned managed identities from an existing image builder.

az image builder identity remove --name MyImageBuilderTemplate --resource-group MyResourceGroup --user-assigned

Optional Parameters

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--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

The name of the image template.

--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.

--user-assigned

Specify one user assigned identity (name or ID, space delimited) of the image template.

--yes -y

Do not prompt for confirmation.

Default value: False
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 image builder identity show

Display managed identities of a image builder template.

az image builder identity show [--defer]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Examples

Display managed identities of a image builder template.

az image builder identity show --name MyImageBuilderTemplate --resource-group MyResourceGroup

Optional Parameters

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--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

The name of the image template.

--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.