az appservice domain

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage custom domains.

Commands

Name	Description	Type	Status
az appservice domain create	Create and purchase a custom domain.	Core	Preview
az appservice domain show-terms	Show the legal terms for purchasing and creating a custom domain.	Core	Preview

az appservice domain create

Preview

Command group 'appservice domain' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create and purchase a custom domain.

az appservice domain create --contact-info
                            --hostname
                            --resource-group
                            [--accept-terms]
                            [--auto-renew]
                            [--dryrun]
                            [--privacy]
                            [--tags]

Examples

Accept the legal terms for purchasing and creating MyCustomDomain.com, then purchase and create domain.

az appservice domain create -g MyResourceGroup --hostname MyCustomDomain.com --contact-info=@'C:/path_to_contact_info.json' --accept-terms

View the details of the domain that will be purchased and created, without actually running the operation

az appservice domain create -g MyResourceGroup --hostname MyCustomDomain.com --contact-info=@'C:/path_to_contact_info.json' --dryrun

Required Parameters

--contact-info -c

The file path to a JSON object with your contact info for domain registration. Please see the following link for the format of the JSON file expected: https://github.com/AzureAppServiceCLI/appservice_domains_templates/blob/master/contact_info.json.

--hostname -n

Name of the custom domain.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--accept-terms

By using this flag, you are accepting the conditions shown using the --show-hostname-purchase-terms flag.

Property	Value
Default value:	False

--auto-renew -a

Enable auto-renew on the domain.

Property	Value
Default value:	True

--dryrun

Show summary of the purchase and create operation instead of executing it.

Property	Value
Default value:	False

--privacy -p

Enable privacy protection.

Property	Value
Default value:	True

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az appservice domain show-terms

Preview

Command group 'appservice domain' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the legal terms for purchasing and creating a custom domain.

az appservice domain show-terms --hostname

Examples

Show the legal terms for purchasing and creating MyCustomDomain.com

az appservice domain show-terms --hostname MyCustomDomain.com

Required Parameters

--hostname -n

Name of the custom domain.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False