Share via


az batch application package

Manage Batch application packages.

Commands

Name Description Type Status
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 package activate

Experimental Preview Deprecated

Activates a Batch application package.

This step is unnecessary if the package has already been successfully activated by the create command.

az batch application package activate --application-name
                                      --format
                                      --name
                                      --resource-group
                                      --version-name

Examples

Required Parameters

--application-name
Experimental Preview Deprecated

The name of the application.

--format
Experimental Preview Deprecated

The format of the application package binary file.

--name -n
Experimental Preview Deprecated

Name of the Batch account.

--resource-group -g
Experimental Preview Deprecated

Name of the resource group.

--version-name
Experimental Preview Deprecated

The version name of the application.

Optional Parameters

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az batch application package create

Experimental Preview Deprecated

Create a Batch application package record and activate it.

az batch application package create --application-name
                                    --name
                                    --package-file
                                    --resource-group
                                    --version-name

Examples

Required Parameters

--application-name
Experimental Preview Deprecated

The name of the application.

--name -n
Experimental Preview Deprecated

Name of the Batch account.

--package-file
Experimental Preview Deprecated

The path of the application package in zip format.

--resource-group -g
Experimental Preview Deprecated

Name of the resource group.

--version-name
Experimental Preview Deprecated

The version name of the application.

Optional Parameters

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az batch application package delete

Experimental Preview Deprecated

Deletes an application package record and its associated binary file.

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

Examples

Required Parameters

--application-name
Experimental Preview Deprecated

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

--name -n
Experimental Preview Deprecated

Name of the Batch account.

--resource-group -g
Experimental Preview Deprecated

Name of the resource group.

--version-name
Experimental Preview Deprecated

The version of the application. Required.

Optional Parameters

--yes -y
Experimental Preview Deprecated

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az batch application package list

Experimental Preview Deprecated

Lists all of the application packages in the specified application.

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

Examples

Required Parameters

--application-name
Experimental Preview Deprecated

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

--name -n
Experimental Preview Deprecated

Name of the Batch account.

--resource-group -g
Experimental Preview Deprecated

Name of the resource group.

Optional Parameters

--maxresults
Experimental Preview Deprecated

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

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az batch application package show

Experimental Preview Deprecated

Gets information about the specified application package.

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

Examples

Required Parameters

--application-name
Experimental Preview Deprecated

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

--name -n
Experimental Preview Deprecated

Name of the Batch account.

--resource-group -g
Experimental Preview Deprecated

Name of the resource group.

--version-name
Experimental Preview Deprecated

The version of the application. Required.

Optional Parameters

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.