application_packages

Creates, updates, deletes, gets or lists an application_packages resource.

Overview

Name	application_packages
Type	Resource
Id	azure.batch.application_packages

Fields

The following fields are returned by SELECT queries:

get

The operation was successful. The response contains the application package entity.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
properties	object	The properties associated with the Application Package.
tags	object	The tags of the resource.
type	string	The type of the resource.

list

The operation was successful. The response contains a list of the application package entities associated with the specified application.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
properties	object	The properties associated with the Application Package.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, applicationName, versionName, subscriptionId		Gets information about the specified application package.
list	select	resourceGroupName, accountName, applicationName, subscriptionId	maxresults	Lists all of the application packages in the specified application.
create	insert	resourceGroupName, accountName, applicationName, versionName, subscriptionId		Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the ApplicationPackage needs to be activated using ApplicationPackageActive before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.
delete	delete	resourceGroupName, accountName, applicationName, versionName, subscriptionId		Deletes an application package record and its associated binary file.
activate	exec	resourceGroupName, accountName, applicationName, versionName, subscriptionId, format		Activates the specified application package. This should be done after the ApplicationPackage was created and uploaded. This needs to be done before an ApplicationPackage can be used on Pools or Tasks.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	The name of the Batch account.
applicationName	string	The name of the application. This must be unique within the account.
resourceGroupName	string	The name of the resource group that contains the Batch account.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
versionName	string	The version of the application.
maxresults	integer (int32)	The maximum number of items to return in the response.

SELECT examples

get

Gets information about the specified application package.

SELECT
id,
name,
etag,
properties,
tags,
type
FROM azure.batch.application_packages
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND applicationName = '{{ applicationName }}' -- required
AND versionName = '{{ versionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all of the application packages in the specified application.

SELECT
id,
name,
etag,
properties,
tags,
type
FROM azure.batch.application_packages
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND applicationName = '{{ applicationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND maxresults = '{{ maxresults }}'
;

INSERT examples

create

Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the ApplicationPackage needs to be activated using ApplicationPackageActive before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.

INSERT INTO azure.batch.application_packages (
data__properties,
data__tags,
resourceGroupName,
accountName,
applicationName,
versionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ applicationName }}',
'{{ versionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: application_packages
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the application_packages resource.
    - name: accountName
      value: string
      description: Required parameter for the application_packages resource.
    - name: applicationName
      value: string
      description: Required parameter for the application_packages resource.
    - name: versionName
      value: string
      description: Required parameter for the application_packages resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the application_packages resource.
    - name: properties
      value: object
      description: |
        The properties associated with the Application Package.
    - name: tags
      value: object
      description: |
        The tags of the resource.

DELETE examples

delete

Deletes an application package record and its associated binary file.

DELETE FROM azure.batch.application_packages
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND applicationName = '{{ applicationName }}' --required
AND versionName = '{{ versionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

activate

Activates the specified application package. This should be done after the ApplicationPackage was created and uploaded. This needs to be done before an ApplicationPackage can be used on Pools or Tasks.

EXEC azure.batch.application_packages.activate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@applicationName='{{ applicationName }}' --required, 
@versionName='{{ versionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"format": "{{ format }}"
}'
;