Share via

az webapp config hostname

  • Reference

Configure hostnames for a web app.

Commands

Name Description Type Status
az webapp config hostname add

Bind a hostname to a web app.

 Core GA
az webapp config hostname delete

Unbind a hostname from a web app.

 Core GA
az webapp config hostname get-external-ip

Get the external-facing IP address for a web app.

 Core GA
az webapp config hostname list

List all hostname bindings for a web app.

 Core GA

az webapp config hostname add

Bind a hostname to a web app.

az webapp config hostname add [--hostname]
                              [--ids]
                              [--resource-group]
                              [--slot]
                              [--subscription]
                              [--webapp-name]

Examples

Bind a hostname to a web app. (autogenerated)

az webapp config hostname add --hostname cname.mycustomdomain.com --resource-group MyResourceGroup --webapp-name MyWebapp

Optional Parameters

--hostname

Hostname assigned to the site, such as custom domains.

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

--resource-group -g

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

--slot -s

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

--subscription

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

--webapp-name

Webapp name. You can configure the default using az configure --defaults web=<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 webapp config hostname delete

Unbind a hostname from a web app.

az webapp config hostname delete [--hostname]
                                 [--ids]
                                 [--resource-group]
                                 [--slot]
                                 [--subscription]
                                 [--webapp-name]

Optional Parameters

--hostname

Hostname assigned to the site, such as custom domains.

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

--resource-group -g

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

--slot -s

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

--subscription

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

--webapp-name

Webapp name. You can configure the default using az configure --defaults web=<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 webapp config hostname get-external-ip

Get the external-facing IP address for a web app.

az webapp config hostname get-external-ip [--ids]
                                          [--resource-group]
                                          [--subscription]
                                          [--webapp-name]

Examples

Get the external-facing IP address for a web app. (autogenerated)

az webapp config hostname get-external-ip --resource-group MyResourceGroup --webapp-name MyWebapp

Optional Parameters

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

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

--webapp-name

Webapp name. You can configure the default using az configure --defaults web=<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 webapp config hostname list

List all hostname bindings for a web app.

az webapp config hostname list --resource-group
                               --webapp-name
                               [--slot]

Examples

List all hostname bindings for a web app. (autogenerated)

az webapp config hostname list --resource-group MyResourceGroup --webapp-name MyWebapp

Required Parameters

--resource-group -g

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

--webapp-name

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

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.