Share via

az webapp hybrid-connection

  • Reference

Methods that list, add and remove hybrid-connections from webapps.

Commands

Name Description Type Status
az webapp hybrid-connection add

Add an existing hybrid-connection to a webapp.

 Core GA
az webapp hybrid-connection list

List the hybrid-connections on a webapp.

 Core GA
az webapp hybrid-connection remove

Remove a hybrid-connection from a webapp.

 Core GA

az webapp hybrid-connection add

Add an existing hybrid-connection to a webapp.

az webapp hybrid-connection add --hybrid-connection
                                --name
                                --namespace
                                --resource-group
                                [--slot]

Examples

add a hybrid-connection to a webapp

az webapp hybrid-connection add -g MyResourceGroup -n MyWebapp --namespace [HybridConnectionNamespace] --hybrid-connection [HybridConnectionName] -s [slot]

Required Parameters

--hybrid-connection

Hybrid connection name.

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--namespace

Hybrid connection namespace.

--resource-group -g

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

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 webapp hybrid-connection list

List the hybrid-connections on a webapp.

az webapp hybrid-connection list --name
                                 --resource-group
                                 [--slot]

Examples

list the hybrid-connections on a webapp

az webapp hybrid-connection list -g MyResourceGroup -n MyWebapp -s [slot]

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

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

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 webapp hybrid-connection remove

Remove a hybrid-connection from a webapp.

az webapp hybrid-connection remove --hybrid-connection
                                   --name
                                   --namespace
                                   --resource-group
                                   [--slot]

Examples

remove a hybrid-connection from a webapp

az webapp hybrid-connection remove  -g MyResourceGroup -n MyWebapp --namespace [HybridConnectionNamespace] --hybrid-connection [HybridConnectionName] -s [slot]

Required Parameters

--hybrid-connection

Hybrid connection name.

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--namespace

Hybrid connection namespace.

--resource-group -g

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

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

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.