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

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

Required Parameters

--application-name

The name of the application.

--format

The format of the application package binary file.

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

--version-name

The version name of the application.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az batch application package create

Create a Batch application package record and activate it.

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

Examples

Create a Batch application package record and activate it.

az batch application package create -g rg -n batch --application-name myapp --version 1.0 --package-file PackageFilePath

Required Parameters

--application-name

The name of the application.

--name -n

Name of the Batch account.

--package-file

The path of the application package in zip format.

--resource-group -g

Name of the resource group.

--version-name

The version name of the application.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az batch application package delete

Deletes an application package record and its associated binary file.

az batch application package delete --application-name
                                    --name
                                    --resource-group
                                    --version-name
                                    [--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.

--version-name

The version of the application. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az batch application package list

Lists all of the application packages in the specified application.

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az batch application package show

Gets information about the specified application package.

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

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.

--version-name

The version of the application. Required.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False