Share via

az webpubsub custom-domain

  • Reference

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az webpubsub custom-domain command. Learn more about extensions.

Manage custom domain settings.

Commands

Name Description Type Status
az webpubsub custom-domain create

Create a custom domain of WebPubSub Service.

 Extension GA
az webpubsub custom-domain delete

Delete a custom domain of WebPubSub Service.

 Extension GA
az webpubsub custom-domain list

List custom domains of WebPubSub Service.

 Extension GA
az webpubsub custom-domain show

Show the detail of a custom domain of WebPubSub Service.

 Extension GA

az webpubsub custom-domain create

Create a custom domain of WebPubSub Service.

az webpubsub custom-domain create --certificate-resource-id
                                  --domain-name
                                  --name
                                  --resource-group
                                  --webpubsub-name

Examples

Create a custom domain

az webpubsub custom-domain create --webpubsub-name MyWebPubSub -g MyResourceGroup --name MyDomain --domain-name MyDomain.com --certificate-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Web/certificates/MyCertificate

Required Parameters

--certificate-resource-id

Resource ID of the certificate.

--domain-name

Custom domain name. For example, contoso.com.

--name

Name of the custom domain.

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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 webpubsub custom-domain delete

Delete a custom domain of WebPubSub Service.

az webpubsub custom-domain delete --name
                                  --resource-group
                                  --webpubsub-name

Examples

Delete a custom domain

az webpubsub custom-domain delete --webpubsub-name MyWebPubSub -g MyResourceGroup --name MyDomain

Required Parameters

--name

Name of the custom domain.

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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 webpubsub custom-domain list

List custom domains of WebPubSub Service.

az webpubsub custom-domain list --resource-group
                                --webpubsub-name

Examples

List custom domains

az webpubsub custom-domain list --webpubsub-name MyWebPubSub -g MyResourceGroup

Required Parameters

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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 webpubsub custom-domain show

Show the detail of a custom domain of WebPubSub Service.

az webpubsub custom-domain show --name
                                --resource-group
                                --webpubsub-name

Examples

Show custom domain

az webpubsub custom-domain show --webpubsub-name MyWebPubSub -g MyResourceGroup --name MyDomain

Required Parameters

--name

Name of the custom domain.

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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.