Share via

az containerapp env java-component gateway-for-spring

  • Preview
  • Reference

Note

This reference is part of the containerapp extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az containerapp env java-component gateway-for-spring command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage the Gateway for Spring for the Container Apps environment.

Commands

Name Description Type Status
az containerapp env java-component gateway-for-spring create

Command to create the Gateway for Spring.

 Extension Preview
az containerapp env java-component gateway-for-spring delete

Command to delete the Gateway for Spring.

 Extension Preview
az containerapp env java-component gateway-for-spring show

Command to show the Gateway for Spring.

 Extension Preview
az containerapp env java-component gateway-for-spring update

Command to update the Gateway for Spring.

 Extension Preview

az containerapp env java-component gateway-for-spring create

Preview

Command group 'containerapp env java-component gateway-for-spring' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to create the Gateway for Spring.

az containerapp env java-component gateway-for-spring create --environment
                                                             --name
                                                             --resource-group
                                                             [--configuration]
                                                             [--max-replicas]
                                                             [--min-replicas]
                                                             [--no-wait]
                                                             [--route-yaml]

Examples

Create a Gateway for Spring with default configuration.

az containerapp env java-component gateway-for-spring create -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment \
    --route-yaml MyRouteYamlFilePath

Create a Gateway for Spring with custom configurations.

az containerapp env java-component gateway-for-spring create -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment \
    --route-yaml MyRouteYamlFilePath \
    --configuration PropertyName1=Value1 PropertyName2=Value2

Create a Gateway for Spring with multiple replicas.

az containerapp env java-component gateway-for-spring create -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment \
    --route-yaml MyRouteYamlFilePath \
    --min-replicas 2 --max-replicas 2

Required Parameters

--environment

The environment name.

--name -n

The Java component name.

--resource-group -g

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

Optional Parameters

--configuration

Java component configuration. Configuration must be in format "=" "="...

--max-replicas

Maximum number of replicas to run for the Java component.

Default value: 1
--min-replicas

Minimum number of replicas to run for the Java component.

Default value: 1
--no-wait

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

Default value: False
--route-yaml --yaml

Path to a .yaml file with the configuration of a Spring Cloud Gateway route. For an example, see https://aka.ms/gateway-for-spring-routes-yaml.

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 containerapp env java-component gateway-for-spring delete

Preview

Command group 'containerapp env java-component gateway-for-spring' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to delete the Gateway for Spring.

az containerapp env java-component gateway-for-spring delete --environment
                                                             --name
                                                             --resource-group
                                                             [--no-wait]
                                                             [--yes]

Examples

Delete a Gateway for Spring.

az containerapp env java-component gateway-for-spring delete -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment

Required Parameters

--environment

The environment name.

--name -n

The Java component name.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False
--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 containerapp env java-component gateway-for-spring show

Preview

Command group 'containerapp env java-component gateway-for-spring' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to show the Gateway for Spring.

az containerapp env java-component gateway-for-spring show --environment
                                                           --name
                                                           --resource-group

Examples

Show Gateway for Spring.

az containerapp env java-component gateway-for-spring show -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment

Required Parameters

--environment

The environment name.

--name -n

The Java component name.

--resource-group -g

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

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 containerapp env java-component gateway-for-spring update

Preview

Command group 'containerapp env java-component gateway-for-spring' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to update the Gateway for Spring.

az containerapp env java-component gateway-for-spring update --environment
                                                             --name
                                                             --resource-group
                                                             [--configuration]
                                                             [--max-replicas]
                                                             [--min-replicas]
                                                             [--no-wait]
                                                             [--route-yaml]

Examples

Update a Gateway for Spring with new routes.

az containerapp env java-component gateway-for-spring update -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment \
    --route-yaml MyRouteYamlFilePath

Delete all configurations of the Gateway for Spring.

az containerapp env java-component gateway-for-spring update -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment \
    --configuration

Update a Gateway for Spring with custom configurations.

az containerapp env java-component gateway-for-spring update -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment \
    --configuration PropertyName1=Value1 PropertyName2=Value2

Required Parameters

--environment

The environment name.

--name -n

The Java component name.

--resource-group -g

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

Optional Parameters

--configuration

Java component configuration. Configuration must be in format "=" "="...

--max-replicas

Maximum number of replicas to run for the Java component.

--min-replicas

Minimum number of replicas to run for the Java component.

--no-wait

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

Default value: False
--route-yaml --yaml

Path to a .yaml file with the configuration of a Spring Cloud Gateway route. For an example, see https://aka.ms/gateway-for-spring-routes-yaml.

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.