az spring-cloud api-portal
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 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 API portal in Azure Spring Cloud.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az spring-cloud api-portal clear |
Clear all settings of API portal. |
Extension | Preview and Deprecated |
| az spring-cloud api-portal custom-domain |
Commands to manage custom domains for API portal. |
Extension | Preview and Deprecated |
| 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 show |
Show the settings, provisioning status and runtime status of API portal. |
Extension | Preview and Deprecated |
| az spring-cloud api-portal update |
Update an existing API portal properties. |
Extension | Preview and Deprecated |
az spring-cloud api-portal clear
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' is deprecated and will be removed in a future release. Use 'spring api-portal' instead.
Clear all settings of API portal.
az spring-cloud api-portal clear --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 api-portal show
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' is deprecated and will be removed in a future release. Use 'spring api-portal' instead.
Show the settings, provisioning status and runtime status of API portal.
az spring-cloud api-portal 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 api-portal update
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' is deprecated and will be removed in a future release. Use 'spring api-portal' instead.
Update an existing API portal properties.
az spring-cloud api-portal update --resource-group
--service
[--assign-endpoint {false, true}]
[--client-id]
[--client-secret]
[--https-only {false, true}]
[--instance-count]
[--issuer-uri]
[--scope]Examples
Update API portal property.
az spring-cloud api-portal 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
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.
If true, access endpoint via https.
Number of instance.
The URI of Issuer Identifier.
Comma-separated list of the specific actions applications can be allowed to do on a user's behalf.
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.
