Share via

az spring api-portal custom-domain

  • Deprecated

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 api-portal custom-domain command. Learn more about extensions.

This command group is implicitly deprecated because command group 'spring' is deprecated and will be removed in a future release.

Commands to manage custom domains for API portal.

Commands

Name Description Type Status
az spring api-portal custom-domain bind

Bind a custom domain with the API portal.

 Extension Deprecated
az spring api-portal custom-domain list

List all custom domains of the API portal.

 Extension Deprecated
az spring api-portal custom-domain show

Show details of a custom domain.

 Extension Deprecated
az spring api-portal custom-domain unbind

Unbind a custom-domain of the API portal.

 Extension Deprecated
az spring api-portal custom-domain update

Update a custom domain of the API portal.

 Extension Deprecated

az spring api-portal custom-domain bind

Deprecated

This command is implicitly deprecated because command group 'spring' is deprecated and will be removed in a future release.

Bind a custom domain with the API portal.

az spring api-portal custom-domain bind --domain-name
                                        --resource-group
                                        --service
                                        [--certificate]

Examples

Bind a custom domain to API portal.

az spring api-portal custom-domain bind --domain-name MyDomainName --certificate MyCertName --service MyCluster --resource-group MyResourceGroup

Required Parameters

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

--certificate

Certificate name in Azure Spring Apps.

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 spring api-portal custom-domain list

Deprecated

This command is implicitly deprecated because command group 'spring' is deprecated and will be removed in a future release.

List all custom domains of the API portal.

az spring api-portal custom-domain list --resource-group
                                        --service

Examples

List all custom domains of the API portal.

az spring api-portal custom-domain list --service MyCluster --resource-group MyResourceGroup

Required Parameters

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

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

Deprecated

This command is implicitly deprecated because command group 'spring' is deprecated and will be removed in a future release.

Show details of a custom domain.

az spring api-portal custom-domain show --domain-name
                                        --resource-group
                                        --service

Required Parameters

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

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

Deprecated

This command is implicitly deprecated because command group 'spring' is deprecated and will be removed in a future release.

Unbind a custom-domain of the API portal.

az spring api-portal custom-domain unbind --domain-name
                                          --resource-group
                                          --service

Required Parameters

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

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

Deprecated

This command is implicitly deprecated because command group 'spring' is deprecated and will be removed in a future release.

Update a custom domain of the API portal.

az spring api-portal custom-domain update --domain-name
                                          --resource-group
                                          --service
                                          [--certificate]

Examples

Bind custom domain with a specified certificate.

az spring api-portal custom-domain update --domain-name MyDomainName --certificate MCertName --service MyCluster --resource-group MyResourceGroup

Required Parameters

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

--certificate

Certificate name in Azure Spring Apps.

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