az image builder identity

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the image template.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--user-assigned

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

Property	Value
Parameter group:	Managed Identity Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the image template.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--user-assigned

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

Property	Value
Parameter group:	Managed Identity Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the image template.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False