az spring-cloud gateway
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 command. Learn more about extensions.
This command group 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' is deprecated and will be removed in a future release. Use 'spring' instead.
(Enterprise Tier Only) Commands to manage gateway in Azure Spring Cloud.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az spring-cloud gateway clear |
Clear all settings of gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway custom-domain |
Commands to manage custom domains for gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway custom-domain bind |
Bind a custom domain with the gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway custom-domain list |
List all custom domains of the gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway custom-domain show |
Show details of a custom domain. |
Extension | Preview and Deprecated |
| az spring-cloud gateway custom-domain unbind |
Unbind a custom-domain of the gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway custom-domain update |
Update a custom domain of the gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway route-config |
Commands to manage gateway route configs in Azure Spring Cloud. |
Extension | Preview and Deprecated |
| 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 show |
Show the settings, provisioning status and runtime status of gateway. |
Extension | Preview and Deprecated |
| az spring-cloud gateway update |
Update an existing gateway properties. |
Extension | Preview and Deprecated |
az spring-cloud gateway clear
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' is deprecated and will be removed in a future release. Use 'spring gateway' instead.
Clear all settings of gateway.
az spring-cloud gateway clear --resource-group
--service
[--no-wait]Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring-cloud gateway show
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' is deprecated and will be removed in a future release. Use 'spring gateway' instead.
Show the settings, provisioning status and runtime status of gateway.
az spring-cloud gateway show --resource-group
--serviceRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring-cloud gateway update
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' is deprecated and will be removed in a future release. Use 'spring gateway' instead.
Update an existing gateway properties.
az spring-cloud gateway update --resource-group
--service
[--allow-credentials {false, true}]
[--allowed-headers]
[--allowed-methods]
[--allowed-origins]
[--api-description]
[--api-doc-location]
[--api-title]
[--api-version]
[--assign-endpoint {false, true}]
[--client-id]
[--client-secret]
[--cpu]
[--exposed-headers]
[--https-only {false, true}]
[--instance-count]
[--issuer-uri]
[--max-age]
[--memory]
[--no-wait]
[--scope]
[--server-url]Examples
Update gateway property.
az spring-cloud gateway update -s MyService -g MyResourceGroup --assign-endpoint true --https-only trueRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.
Optional Parameters
Whether user credentials are supported on cross-site requests.
Comma-separated list of allowed headers in cross-site requests. The special value * allows actual requests to send any header.
Comma-separated list of allowed HTTP methods on cross-site requests. The special value * allows all methods.
Comma-separated list of allowed origins to make cross-site requests. The special value * allows all domains.
Detailed description of the APIs available on the Gateway instance.
Location of additional documentation for the APIs available on the Gateway instance.
Title describing the context of the APIs available on the Gateway instance.
Version of APIs available on this Gateway instance.
If true, assign endpoint URL for direct access.
The public identifier for the application.
The secret known only to the application and the authorization server.
CPU resource quantity. Should be 500m or number of CPU cores.
Comma-separated list of HTTP response headers to expose for cross-site requests.
If true, access endpoint via https.
Number of instance.
The URI of Issuer Identifier.
How long, in seconds, the response from a pre-flight request can be cached by clients.
Memory resource quantity. Should be 512Mi or #Gi, e.g., 1Gi, 3Gi.
Do not wait for the long-running operation to finish.
Comma-separated list of the specific actions applications can be allowed to do on a user's behalf.
Base URL that API consumers will use to access APIs on the Gateway instance.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for