Share via

az batch application

  • Reference

Manage Batch applications.

Commands

Name Description Type Status
az batch application create

Adds an application to the specified Batch account.

 Core GA
az batch application delete

Deletes an application.

 Core GA
az batch application list

Lists all of the applications in the specified account.

 Core GA
az batch application package

Manage Batch application packages.

 Core GA
az batch application package activate

Activates a Batch application package.

 Core GA
az batch application package create

Create a Batch application package record and activate it.

 Core GA
az batch application package delete

Deletes an application package record and its associated binary file.

 Core GA
az batch application package list

Lists all of the application packages in the specified application.

 Core GA
az batch application package show

Gets information about the specified application package.

 Core GA
az batch application set

Update properties for a Batch application.

 Core GA
az batch application show

Gets information about the specified application.

 Core GA
az batch application summary

View a summary of Batch application packages.

 Core GA
az batch application summary list

Lists all of the applications available in the specified account.

 Core GA
az batch application summary show

Gets information about the specified application.

 Core GA

az batch application create

Edit

Adds an application to the specified Batch account.

az batch application create --application-name
                            --name
                            --resource-group
                            [--parameters]

Required Parameters

--application-name

The name of the application. This must be unique within the account. Required.

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--parameters

The parameters for the request. Is either a Application type or a IO type. Default value is None.

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 batch application delete

Edit

Deletes an application.

az batch application delete --application-name
                            --name
                            --resource-group
                            [--yes]

Required Parameters

--application-name

The name of the application. This must be unique within the account. Required.

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

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 batch application list

Edit

Lists all of the applications in the specified account.

az batch application list --name
                          --resource-group
                          [--maxresults]

Required Parameters

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--maxresults

The maximum number of items to return in the response. Default value is None.

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 batch application set

Edit

Update properties for a Batch application.

az batch application set --application-name
                         --name
                         --resource-group
                         [--allow-updates]
                         [--default-version]
                         [--display-name]

Required Parameters

--application-name

The name of the application.

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--allow-updates

Specify to indicate whether packages within the application may be overwritten using the same version string. Specify either 'true' or 'false' to update the property.

--default-version

Specify which package to use if a client requests the application but does not specify a version.

--display-name

Specify the display name for the application.

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

Edit

Gets information about the specified application.

az batch application show --application-name
                          --name
                          --resource-group

Required Parameters

--application-name

The name of the application. This must be unique within the account. Required.

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

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.