az spring api-portal

  • Reference

Note

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

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

Commands

Name Description Type Status
az spring api-portal clear

Clear all settings of API portal.

 Extension GA
az spring api-portal create

Create API portal.

 Extension GA
az spring api-portal custom-domain

Commands to manage custom domains for API portal.

 Extension GA
az spring api-portal custom-domain bind

Bind a custom domain with the API portal.

 Extension GA
az spring api-portal custom-domain list

List all custom domains of the API portal.

 Extension GA
az spring api-portal custom-domain show

Show details of a custom domain.

 Extension GA
az spring api-portal custom-domain unbind

Unbind a custom-domain of the API portal.

 Extension GA
az spring api-portal custom-domain update

Update a custom domain of the API portal.

 Extension GA
az spring api-portal delete

Delete API portal.

 Extension GA
az spring api-portal show

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

 Extension GA
az spring api-portal update

Update an existing API portal properties.

 Extension GA

az spring api-portal clear

Clear all settings of API portal.

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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 api-portal create

Create API portal.

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

Examples

Create API portal.

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

Optional Parameters

--instance-count

Number of instance.

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 api-portal delete

Delete API portal.

az spring api-portal delete --resource-group
                            --service
                            [--yes]

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

Optional Parameters

--yes -y

Do not prompt for confirmation.

default value: False
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 api-portal show

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

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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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

Update an existing API portal properties.

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

Examples

Update API portal property.

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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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.

--enable-api-try-out

Try out the API by sending requests and viewing responses in API portal.

accepted values: false, true
--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.

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.