Share via

az spring-cloud api-portal custom-domain

  • Preview
  • Deprecated
  • Reference

Note

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

Command group 'spring-cloud api-portal' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command group is implicitly deprecated because command group 'spring-cloud api-portal' is deprecated and will be removed in a future release. Use 'spring api-portal' instead.

Commands to manage custom domains for API portal.

Commands

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

Bind a custom domain with the API portal.

 Extension Preview and Deprecated
az spring-cloud api-portal custom-domain list

List all custom domains of the API portal.

 Extension Preview and Deprecated
az spring-cloud api-portal custom-domain show

Show details of a custom domain.

 Extension Preview and Deprecated
az spring-cloud api-portal custom-domain unbind

Unbind a custom-domain of the API portal.

 Extension Preview and Deprecated
az spring-cloud api-portal custom-domain update

Update a custom domain of the API portal.

 Extension Preview and Deprecated

az spring-cloud api-portal custom-domain bind

Preview Deprecated

Command group 'spring-cloud api-portal' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'spring-cloud api-portal custom-domain' is deprecated and will be removed in a future release. Use 'spring api-portal custom-domain' instead.

Bind a custom domain with the API portal.

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

Examples

Bind a custom domain to API portal.

az spring-cloud 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

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--certificate

Certificate name in Azure Spring Cloud.

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

Preview Deprecated

Command group 'spring-cloud api-portal' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'spring-cloud api-portal custom-domain' is deprecated and will be removed in a future release. Use 'spring api-portal custom-domain' instead.

List all custom domains of the API portal.

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

Examples

List all custom domains of the API portal.

az spring-cloud 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

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

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

Preview Deprecated

Command group 'spring-cloud api-portal' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'spring-cloud api-portal custom-domain' is deprecated and will be removed in a future release. Use 'spring api-portal custom-domain' instead.

Show details of a custom domain.

az spring-cloud 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

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

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

Preview Deprecated

Command group 'spring-cloud api-portal' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'spring-cloud api-portal custom-domain' is deprecated and will be removed in a future release. Use 'spring api-portal custom-domain' instead.

Unbind a custom-domain of the API portal.

az spring-cloud 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

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

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

Preview Deprecated

Command group 'spring-cloud api-portal' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'spring-cloud api-portal custom-domain' is deprecated and will be removed in a future release. Use 'spring api-portal custom-domain' instead.

Update a custom domain of the API portal.

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

Examples

Bind custom domain with a specified certificate.

az spring-cloud 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

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--certificate

Certificate name in Azure Spring Cloud.

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.