az spring-cloud gateway route-config

  • 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 gateway route-config command. Learn more about extensions.

Command group 'spring-cloud gateway' 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 gateway' is deprecated and will be removed in a future release. Use 'spring gateway' instead.

Commands to manage gateway route configs in Azure Spring Cloud.

Commands

Name Description Type Status
az spring-cloud gateway route-config create

Create a gateway route config with routing rules of Json array format.

 Extension Preview and Deprecated
az spring-cloud gateway route-config list

List all existing gateway route configs.

 Extension Preview and Deprecated
az spring-cloud gateway route-config remove

Delete an existing gateway route config.

 Extension Preview and Deprecated
az spring-cloud gateway route-config show

Get an existing gateway route config.

 Extension Preview and Deprecated
az spring-cloud gateway route-config update

Update an existing gateway route config with routing rules of Json array format.

 Extension Preview and Deprecated

az spring-cloud gateway route-config create

Preview Deprecated

Command group 'spring-cloud gateway' 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 gateway route-config' is deprecated and will be removed in a future release. Use 'spring gateway route-config' instead.

Create a gateway route config with routing rules of Json array format.

az spring-cloud gateway route-config create --name
                                            --resource-group
                                            --service
                                            [--app-name]
                                            [--routes-file]
                                            [--routes-json]

Examples

Create a gateway route config targeting the app in Azure Spring Cloud.

az spring-cloud gateway route-config create -s MyService -g MyResourceGroup --name MyName --app-name MyApp --routes-file MyJson.json

Required Parameters

--name -n

Name of route config.

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

--app-name

The Azure Spring Cloud app name to configure the route.

--routes-file

The file path of JSON array of API routes.

--routes-json

The JSON array of API routes.

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 gateway route-config list

Preview Deprecated

Command group 'spring-cloud gateway' 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 gateway route-config' is deprecated and will be removed in a future release. Use 'spring gateway route-config' instead.

List all existing gateway route configs.

az spring-cloud gateway route-config list --resource-group
                                          --service

Examples

List all existing gateway route configs.

az spring-cloud gateway route-config list -s MyService -g 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 gateway route-config remove

Preview Deprecated

Command group 'spring-cloud gateway' 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 gateway route-config' is deprecated and will be removed in a future release. Use 'spring gateway route-config' instead.

Delete an existing gateway route config.

az spring-cloud gateway route-config remove --name
                                            --resource-group
                                            --service

Examples

Delete an existing gateway route config.

az spring-cloud gateway route-config remove -s MyService -g MyResourceGroup --name MyName

Required Parameters

--name -n

Name of route config.

--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 gateway route-config show

Preview Deprecated

Command group 'spring-cloud gateway' 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 gateway route-config' is deprecated and will be removed in a future release. Use 'spring gateway route-config' instead.

Get an existing gateway route config.

az spring-cloud gateway route-config show --name
                                          --resource-group
                                          --service

Examples

Get an existing gateway route config.

az spring-cloud gateway route-config show -s MyService -g MyResourceGroup --name MyName

Required Parameters

--name -n

Name of route config.

--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 gateway route-config update

Preview Deprecated

Command group 'spring-cloud gateway' 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 gateway route-config' is deprecated and will be removed in a future release. Use 'spring gateway route-config' instead.

Update an existing gateway route config with routing rules of Json array format.

az spring-cloud gateway route-config update --name
                                            --resource-group
                                            --service
                                            [--app-name]
                                            [--routes-file]
                                            [--routes-json]

Examples

Update an existing gateway route config targeting the app in Azure Spring Cloud.

az spring-cloud gateway route-config update -s MyService -g MyResourceGroup --name MyName --app-name MyApp --routes-file MyJson.json

Required Parameters

--name -n

Name of route config.

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

--app-name

The Azure Spring Cloud app name to configure the route.

--routes-file

The file path of JSON array of API routes.

--routes-json

The JSON array of API routes.

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.