Share via

az batch account identity

  • Reference

Manage identities of a batch account.

Commands

Name Description Type Status
az batch account identity assign

Add managed identities to an existing batch account.

 Core GA
az batch account identity remove

Remove managed identities from an existing batch account.

 Core GA
az batch account identity show

Display managed identities of a batch account.

 Core GA

az batch account identity assign

Edit

Add managed identities to an existing batch account.

az batch account identity assign --name
                                 --resource-group
                                 [--system-assigned]
                                 [--user-assigned]

Examples

Add a system assigned managed identity to an existing batch account.

az batch account identity assign --name MyBatchAccount --resource-group MyResourceGroup --system-assigned

Add a user assigned managed identity to an existing batch account.

az batch account identity assign --name MyBatchAccount --resource-group MyResourceGroup --user-assigned MyAssignedId

Required Parameters

--name -n

Name of the batch account to show. If not specified will display currently set account.

--resource-group -g

Name of the resource group. If not specified will display currently set account.

Optional Parameters

--system-assigned

Provide this flag to use system assigned identity for batch accounts. Check out help for more examples.

--user-assigned

User Assigned Identity ids to be used for batch account. Check out help for more examples.

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 batch account identity remove

Edit

Remove managed identities from an existing batch account.

az batch account identity remove --name
                                 --resource-group
                                 [--system-assigned]
                                 [--user-assigned]
                                 [--yes]

Examples

Remove a system assigned managed identity from an existing batch account.

az batch account identity remove --name MyBatchAccount --resource-group MyResourceGroup --system-assigned

Remove a user assigned managed identity from an existing batch account.

az batch account identity remove --name MyBatchAccount --resource-group MyResourceGroup --user-assigned MyAssignedId

Remove all user assigned managed identities from an existing batch account.

az batch account identity remove --name MyBatchAccount --resource-group MyResourceGroup --user-assigned

Required Parameters

--name -n

Name of the batch account to show. If not specified will display currently set account.

--resource-group -g

Name of the resource group. If not specified will display currently set account.

Optional Parameters

--system-assigned

Provide this flag to use system assigned identity for batch accounts. Check out help for more examples.

--user-assigned

User Assigned Identity ids to be used for batch account. Check out help for more examples.

--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 batch account identity show

Edit

Display managed identities of a batch account.

[WARNING] The output includes secrets that you must protect. Be sure that you do not include these secrets in your source control. Also verify that no secrets are present in the logs of your command or script. For additional information, see http://aka.ms/clisecrets.

az batch account identity show --name
                               --resource-group

Examples

Display managed identities of a batch account.

az batch account identity show --name MyBatchAccount --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the batch account to show. If not specified will display currently set account.

--resource-group -g

Name of the resource group. If not specified will display currently set account.

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.