Share via

az signalr custom-domain

  • Reference

Manage custom domain settings.

Commands

Name Description Type Status
az signalr custom-domain create

Create a custom domain of SignalR Service.

 Core GA
az signalr custom-domain delete

Delete a custom domain of SignalR Service.

 Core GA
az signalr custom-domain list

List custom domains of SignalR Service.

 Core GA
az signalr custom-domain show

Show the detail of a custom domain of SignalR Service.

 Core GA
az signalr custom-domain update

Update a custom domain of SignalR Service.

 Core GA

az signalr custom-domain create

Edit

Create a custom domain of SignalR Service.

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

Required Parameters

--certificate-resource-id

ResourceId of a previously created custom 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>.

--signalr-name

Name of the SignalR.

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

Edit

Delete a custom domain of SignalR Service.

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

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

--signalr-name

Name of the SignalR.

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

Edit

List custom domains of SignalR Service.

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

Required Parameters

--resource-group -g

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

--signalr-name

Name of the SignalR.

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

Edit

Show the detail of a custom domain of SignalR Service.

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

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

--signalr-name

Name of the SignalR.

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 signalr custom-domain update

Edit

Update a custom domain of SignalR Service.

az signalr custom-domain update --name
                                --resource-group
                                --signalr-name
                                [--add]
                                [--certificate-resource-id]
                                [--domain-name]
                                [--force-string]
                                [--remove]
                                [--set]

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

--signalr-name

Name of the SignalR.

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

Default value: []
--certificate-resource-id

ResourceId of a previously created custom certificate.

--domain-name

Custom domain name. For example, contoso.com.

--force-string

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

Default value: False
--remove

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

Default value: []
--set

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

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