az vmss identity

Manage service identities of a VM scaleset.

Commands

az vmss identity assign Enable managed service identity on a VMSS.
az vmss identity remove Remove user assigned identities from a VM scaleset.
az vmss identity show Display VM scaleset's managed identity info.

az vmss identity assign

Enable managed service identity on a VMSS.

az vmss identity assign [--identities]
[--ids]
[--name]
[--resource-group]
[--role]
[--scope]
[--subscription]

Examples

Enable system assigned identity on a VMSS with the 'Owner' role.

az vmss identity assign -g MyResourceGroup -n MyVmss --role Owner --scope /subscriptions/db5eb68e-73e2-4fa8-b18a-0123456789999/resourceGroups/MyResourceGroup

Optional Parameters

--identities

Space-separated identities to assign. Use '[system]' to refer to the system assigned identity. Default: '[system]'.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Scale set name. You can configure the default using az configure --defaults vmss=<name>.

--resource-group -g

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

--role

Role name or id the system assigned identity will have.

default value: Contributor
--scope

Scope that the system assigned identity can access.

--subscription

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

az vmss identity remove

Remove user assigned identities from a VM scaleset.

az vmss identity remove [--identities]
[--ids]
[--name]
[--resource-group]
[--subscription]

Examples

Remove system assigned identity

az vmss identity remove -g MyResourceGroup -n MyVmss

Remove 2 identities which are in the same resource group with the VM scaleset

az vmss identity remove -g MyResourceGroup -n MyVmss --identities readerId writerId

Remove system assigned identity and a user identity

az vmss identity remove -g MyResourceGroup -n MyVmss --identities [system] readerId

Optional Parameters

--identities

Space-separated identities to remove. Use '[system]' to refer to the system assigned identity. Default: '[system]'.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Scale set name. You can configure the default using az configure --defaults vmss=<name>.

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

az vmss identity show

Display VM scaleset's managed identity info.

az vmss identity show [--ids]
[--name]
[--resource-group]
[--subscription]

Examples

display VM scaleset's managed identity info. (autogenerated)

az vmss identity show --name MyVirtualMachine --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=<name>.

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