applications

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

Overview

Name	applications
Type	Resource
Id	azure.batch.applications

Fields

The following fields are returned by SELECT queries:

get

The operation was successful. The response contains the application 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.
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 entities associated with the specified account.

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.
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, subscriptionId		Gets information about the specified application.
list	select	resourceGroupName, accountName, subscriptionId	maxresults	Lists all of the applications in the specified account.
create	insert	resourceGroupName, accountName, applicationName, subscriptionId		Adds an application to the specified Batch account.
update	update	resourceGroupName, accountName, applicationName, subscriptionId		Updates settings for the specified application.
delete	delete	resourceGroupName, accountName, applicationName, subscriptionId		Deletes an application.

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)
maxresults	integer (int32)	The maximum number of items to return in the response.

SELECT examples

get

Gets information about the specified application.

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

list

Lists all of the applications in the specified account.

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

INSERT examples

create

Adds an application to the specified Batch account.

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

Manifest

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

UPDATE examples

update

Updates settings for the specified application.

UPDATE azure.batch.applications
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND applicationName = '{{ applicationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
etag,
properties,
tags,
type;

DELETE examples

delete

Deletes an application.

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