az network application-gateway identity

Reference

Manage the managed service identity of an application gateway.

Commands

Name	Description	Type	Status
az network application-gateway identity assign	Assign a managed service identity to an application gateway.	Core	GA
az network application-gateway identity remove	Remove the managed service identity of an application-gateway.	Core	GA
az network application-gateway identity show	Show the managed service identity of an application gateway.	Core	GA
az network application-gateway identity wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network application-gateway identity assign

Edit

Assign a managed service identity to an application gateway.

az network application-gateway identity assign --gateway-name
                                               --identity
                                               --resource-group
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Assign an identity to the application gateway.

az network application-gateway identity assign -g MyResourceGroup --gateway-name ag1 --identity /subscriptions/*-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1

Required Parameters

--gateway-name

Name of the application gateway.

--identity

Name or ID of the ManagedIdentity Resource.

--resource-group -g

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

Optional Parameters

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

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 network application-gateway identity remove

Edit

Remove the managed service identity of an application-gateway.

az network application-gateway identity remove [--gateway-name]
                                               [--ids]
                                               [--no-wait]
                                               [--resource-group]
                                               [--subscription]

Examples

Remove an identity to the application gateway

az network application-gateway identity remove -g MyResourceGroup --gateway-name ag1

Optional Parameters

--gateway-name

Name of the application gateway.

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

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

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 network application-gateway identity show

Edit

Show the managed service identity of an application gateway.

az network application-gateway identity show --gateway-name
                                             --resource-group

Examples

Show an identity to the application gateway.

az network application-gateway identity show -g MyResourceGroup --gateway-name ag1

Required Parameters

--gateway-name

Name of the application gateway.

--resource-group -g

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

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 network application-gateway identity wait

Edit

Place the CLI in a waiting state until a condition is met.

az network application-gateway identity wait [--created]
                                             [--custom]
                                             [--deleted]
                                             [--exists]
                                             [--gateway-name]
                                             [--ids]
                                             [--interval]
                                             [--resource-group]
                                             [--subscription]
                                             [--timeout]
                                             [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--gateway-name

Name of the application gateway.

--ids

--interval

Polling interval in seconds.

Default value: 30

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

Share via

az network application-gateway identity

Commands

az network application-gateway identity assign

Examples

Required Parameters

Optional Parameters

az network application-gateway identity remove

Examples

Optional Parameters

az network application-gateway identity show

Examples

Required Parameters

az network application-gateway identity wait

Optional Parameters

Additional resources