Share via

az spring application-accelerator customized-accelerator

  • 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 application-accelerator customized-accelerator command. Learn more about extensions.

(Enterprise Tier Only) Commands to manage customized accelerator in Azure Spring Apps.

Commands

Name Description Type Status
az spring application-accelerator customized-accelerator create

(Enterprise Tier Only) Create a customized accelerator.

 Extension GA
az spring application-accelerator customized-accelerator delete

(Enterprise Tier Only) Delete a customized accelerator.

 Extension GA
az spring application-accelerator customized-accelerator list

(Enterprise Tier Only) List all existing customized accelerators.

 Extension GA
az spring application-accelerator customized-accelerator show

(Enterprise Tier Only) Show the settings, provisioning status and runtime status of customized accelerator.

 Extension GA
az spring application-accelerator customized-accelerator sync-cert

(Enterprise Tier Only) Sync certificate of a customized accelerator.

 Extension GA
az spring application-accelerator customized-accelerator update

(Enterprise Tier Only) Update a customized accelerator.

 Extension GA

az spring application-accelerator customized-accelerator create

(Enterprise Tier Only) Create a customized accelerator.

az spring application-accelerator customized-accelerator create --display-name
                                                                --git-url
                                                                --name
                                                                --resource-group
                                                                --service
                                                                [--accelerator-tags]
                                                                [--ca-cert-name]
                                                                [--description]
                                                                [--git-branch]
                                                                [--git-commit]
                                                                [--git-interval]
                                                                [--git-sub-path]
                                                                [--git-tag]
                                                                [--host-key]
                                                                [--host-key-algorithm]
                                                                [--icon-url]
                                                                [--no-wait]
                                                                [--password]
                                                                [--private-key]
                                                                [--type {Accelerator, Fragment}]
                                                                [--username]

Examples

Create a customized accelerator.

az spring application-accelerator customized-accelerator create --name AcceleratorName --service MyCluster --resource-group MyResourceGroup --git-url https://github.com/xxx --git-branch main --display-name acc-name

Required Parameters

--display-name

Display name for customized accelerator.

--git-url

Git URL.

--name -n

Name for customized accelerator.

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

--accelerator-tags

Comma-separated list of tags on the customized accelerator.

--ca-cert-name

CA certificate name.

--description

Description for customized accelerator.

--git-branch

Git repository branch to be used.

--git-commit

Git repository commit to be used.

--git-interval

Interval in seconds for checking for updates to Git or image repository.

--git-sub-path

Folder path inside the git repository to consider as the root of the accelerator or fragment.

--git-tag

Git repository tag to be used.

--host-key

Public SSH Key of git repository.

--host-key-algorithm

SSH Key algorithm of git repository.

--icon-url

Icon url for customized accelerator.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--password

Password of git repository basic auth.

--private-key

Private SSH Key algorithm of git repository.

--type

Type of customized accelerator.

Accepted values: Accelerator, Fragment
--username

Username of git repository basic auth.

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 application-accelerator customized-accelerator delete

(Enterprise Tier Only) Delete a customized accelerator.

az spring application-accelerator customized-accelerator delete --name
                                                                --resource-group
                                                                --service
                                                                [--no-wait]

Examples

Delete a customized accelerator.

az spring application-accelerator customized-accelerator delete --name AcceleratorName --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

Name for customized accelerator.

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

--no-wait

Do not wait for the long-running operation to finish.

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 application-accelerator customized-accelerator list

(Enterprise Tier Only) List all existing customized accelerators.

az spring application-accelerator customized-accelerator list --resource-group
                                                              --service

Examples

List all existing customized accelerators.

az spring application-accelerator customized-accelerator list --service MyCluster --resource-group MyResourceGroup

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 application-accelerator customized-accelerator show

(Enterprise Tier Only) Show the settings, provisioning status and runtime status of customized accelerator.

az spring application-accelerator customized-accelerator show --name
                                                              --resource-group
                                                              --service

Examples

Show details of a customized accelerator.

az spring application-accelerator customized-accelerator show --name AcceleratorName --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

Name for customized accelerator.

--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 application-accelerator customized-accelerator sync-cert

(Enterprise Tier Only) Sync certificate of a customized accelerator.

az spring application-accelerator customized-accelerator sync-cert --name
                                                                   --resource-group
                                                                   --service
                                                                   [--no-wait]

Examples

Sync certificate of a customized accelerator.

az spring application-accelerator customized-accelerator sync-cert --name AcceleratorName --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

Name for customized accelerator.

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

--no-wait

Do not wait for the long-running operation to finish.

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 application-accelerator customized-accelerator update

(Enterprise Tier Only) Update a customized accelerator.

az spring application-accelerator customized-accelerator update --display-name
                                                                --git-url
                                                                --name
                                                                --resource-group
                                                                --service
                                                                [--accelerator-tags]
                                                                [--ca-cert-name]
                                                                [--description]
                                                                [--git-branch]
                                                                [--git-commit]
                                                                [--git-interval]
                                                                [--git-sub-path]
                                                                [--git-tag]
                                                                [--host-key]
                                                                [--host-key-algorithm]
                                                                [--icon-url]
                                                                [--no-wait]
                                                                [--password]
                                                                [--private-key]
                                                                [--type {Accelerator, Fragment}]
                                                                [--username]

Examples

Update a customized accelerator.

az spring application-accelerator customized-accelerator update --name AcceleratorName --service MyCluster --resource-group MyResourceGroup --git-url https://github.com/xxx --git-branch main --display-name acc-name

Required Parameters

--display-name

Display name for customized accelerator.

--git-url

Git URL.

--name -n

Name for customized accelerator.

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

--accelerator-tags

Comma-separated list of tags on the customized accelerator.

--ca-cert-name

CA certificate name.

--description

Description for customized accelerator.

--git-branch

Git repository branch to be used.

--git-commit

Git repository commit to be used.

--git-interval

Interval in seconds for checking for updates to Git or image repository.

--git-sub-path

Folder path inside the git repository to consider as the root of the accelerator or fragment.

--git-tag

Git repository tag to be used.

--host-key

Public SSH Key of git repository.

--host-key-algorithm

SSH Key algorithm of git repository.

--icon-url

Icon url for customized accelerator.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--password

Password of git repository basic auth.

--private-key

Private SSH Key algorithm of git repository.

--type

Type of customized accelerator.

Accepted values: Accelerator, Fragment
--username

Username of git repository basic auth.

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.