Share via

az network application-gateway client-cert

  • Reference

Manage trusted client certificates of application gateway.

Commands

Name Description Type Status
az network application-gateway client-cert add

Add trusted client certificate of the application gateway.

 Core GA
az network application-gateway client-cert list

List the existing trusted client certificates of the application gateway.

 Core GA
az network application-gateway client-cert remove

Remove an existing trusted client certificate of the application gateway.

 Core GA
az network application-gateway client-cert show

Show an existing trusted client certificate of the application gateway.

 Core GA
az network application-gateway client-cert update

Update trusted client certificate of the application gateway.

 Core GA
az network application-gateway client-cert wait

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

 Core GA

az network application-gateway client-cert add

Edit

Add trusted client certificate of the application gateway.

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

Examples

Add trusted client certificate of the application gateway.

az network application-gateway client-cert add --gateway-name MyAppGateway -g MyResourceGroup --name MyCert --data FilePath

Required Parameters

--data

Path to the certificate file.

--gateway-name

Name of the application gateway.

--name -n

Name of the trusted client certificate.

--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 client-cert list

Edit

List the existing trusted client certificates of the application gateway.

az network application-gateway client-cert list --gateway-name
                                                --resource-group

Examples

List the existing trusted client certificates of the application gateway.

az network application-gateway client-cert list --gateway-name MyAppGateway -g MyResourceGroup

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 client-cert remove

Edit

Remove an existing trusted client certificate of the application gateway.

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

Examples

Remove an existing trusted client certificate of the application gateway.

az network application-gateway client-cert remove --gateway-name MyAppGateway -g MyResourceGroup --name MyCert

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the trusted client certificate.

--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 client-cert show

Edit

Show an existing trusted client certificate of the application gateway.

az network application-gateway client-cert show --gateway-name
                                                --name
                                                --resource-group

Examples

Show an existing trusted client certificate of the application gateway.

az network application-gateway client-cert show --gateway-name MyAppGateway -g MyResourceGroup --name MyCert

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the trusted client certificate.

--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 client-cert update

Edit

Update trusted client certificate of the application gateway.

az network application-gateway client-cert update --data
                                                  --gateway-name
                                                  --name
                                                  --resource-group
                                                  [--add]
                                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--remove]
                                                  [--set]

Examples

Update trusted client certificate of the application gateway.

az network application-gateway client-cert update --gateway-name MyAppGateway -g MyResourceGroup --name MyCert --data FilePath

Required Parameters

--data

Path to the certificate file.

--gateway-name

Name of the application gateway.

--name -n

Name of the trusted client certificate.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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

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

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

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

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 client-cert wait

Edit

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

az network application-gateway client-cert 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

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.

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