az spring-cloud api-portal

Note

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

(Enterprise Tier Only) Commands to manage API portal in Azure Spring Cloud.

Commands

az spring-cloud api-portal clear	Clear all settings of API portal.
az spring-cloud api-portal custom-domain	Commands to manage custom domains for API portal.
az spring-cloud api-portal custom-domain bind	Bind a custom domain with the API portal.
az spring-cloud api-portal custom-domain list	List all custom domains of the API portal.
az spring-cloud api-portal custom-domain show	Show details of a custom domain.
az spring-cloud api-portal custom-domain unbind	Unbind a custom-domain of the API portal.
az spring-cloud api-portal custom-domain update	Update a custom domain of the API portal.
az spring-cloud api-portal show	Show the settings, provisioning status and runtime status of API portal.
az spring-cloud api-portal update	Update an existing API portal properties.

az spring-cloud api-portal clear

Clear all settings of API portal.

az spring-cloud api-portal clear --resource-group
                                 --service

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.

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

Show the settings, provisioning status and runtime status of API portal.

az spring-cloud api-portal show --resource-group
                                --service

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.

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

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 true

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

Optional Parameters

--assign-endpoint

If true, assign endpoint URL for direct access.

accepted values: false, true

--client-id

The public identifier for the application.

--client-secret

The secret known only to the application and the authorization server.

--https-only

If true, access endpoint via https.

accepted values: false, true

--instance-count

Number of instance.

--issuer-uri

The URI of Issuer Identifier.

--scope

Comma-separated list of the specific actions applications can be allowed to do on a user's behalf.

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.

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