Share via

az spring app custom-domain

  • Reference

Note

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

Commands to manage custom domains.

Commands

Name Description Type Status
az spring app custom-domain bind

Bind a custom domain with the app.

 Extension GA
az spring app custom-domain list

List all custom domains of the app.

 Extension GA
az spring app custom-domain show

Show details of a custom domain.

 Extension GA
az spring app custom-domain unbind

Unbind a custom-domain of the app.

 Extension GA
az spring app custom-domain update

Update a custom domain of the app.

 Extension GA

az spring app custom-domain bind

Bind a custom domain with the app.

az spring app custom-domain bind --app
                                 --domain-name
                                 --resource-group
                                 --service
                                 [--certificate]
                                 [--enable-ingress-to-app-tls {false, true}]

Examples

Bind a custom domain to app.

az spring app custom-domain bind --domain-name MyDomainName --certificate MyCertName --app MyAppName --service MyCluster --resource-group MyResourceGroup

Required Parameters

--app

Name of app.

--domain-name

Name of custom domain.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

Optional Parameters

--certificate

Certificate name in Azure Spring Apps.

--enable-ingress-to-app-tls

If true, enable ingress to app tls.

Accepted values: false, true
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 spring app custom-domain list

List all custom domains of the app.

az spring app custom-domain list --app
                                 --resource-group
                                 --service

Examples

List all custom domains of the app.

az spring app custom-domain list --app MyAppName --service MyCluster --resource-group MyResourceGroup -o table

Required Parameters

--app

Name of app.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring app custom-domain show

Show details of a custom domain.

az spring app custom-domain show --app
                                 --domain-name
                                 --resource-group
                                 --service

Required Parameters

--app

Name of app.

--domain-name

Name of custom domain.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring app custom-domain unbind

Unbind a custom-domain of the app.

az spring app custom-domain unbind --app
                                   --domain-name
                                   --resource-group
                                   --service

Required Parameters

--app

Name of app.

--domain-name

Name of custom domain.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring app custom-domain update

Update a custom domain of the app.

az spring app custom-domain update --app
                                   --domain-name
                                   --resource-group
                                   --service
                                   [--certificate]
                                   [--enable-ingress-to-app-tls {false, true}]

Examples

Bind custom domain with a specified certificate.

az spring app custom-domain update --domain-name MyDomainName --certificate MCertName --app MyAppName --service MyCluster --resource-group MyResourceGroup

Required Parameters

--app

Name of app.

--domain-name

Name of custom domain.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

Optional Parameters

--certificate

Certificate name in Azure Spring Apps.

--enable-ingress-to-app-tls

If true, enable ingress to app tls.

Accepted values: false, true
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.