application

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

Overview

Name	application
Type	Resource
Id	azure.batch.application

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowUpdates	boolean	A value indicating whether packages within the application may be overwritten using the same version string.
defaultVersion	string	The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.
displayName	string	The display name for the application.
etag	string	The ETag of the resource, used for concurrency statements.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowUpdates	boolean	A value indicating whether packages within the application may be overwritten using the same version string.
defaultVersion	string	The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.
displayName	string	The display name for the application.
etag	string	The ETag of the resource, used for concurrency statements.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, application_name, subscription_id		Gets information about the specified application.
list	select	resource_group_name, account_name, subscription_id	maxresults	Lists all of the applications in the specified account.
create	insert	resource_group_name, account_name, application_name, subscription_id		Adds an application to the specified Batch account.
update	update	resource_group_name, account_name, application_name, subscription_id		Updates settings for the specified application.
delete	delete	resource_group_name, account_name, application_name, subscription_id		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
account_name	string	A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/ _. Required.
application_name	string	The name of the application. This must be unique within the account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
maxresults	integer	The maximum number of items to return in the response. Default value is None.

SELECT examples

get

Gets information about the specified application.

SELECT
id,
name,
allowUpdates,
defaultVersion,
displayName,
etag,
systemData,
tags,
type
FROM azure.batch.application
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND application_name = '{{ application_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all of the applications in the specified account.

SELECT
id,
name,
allowUpdates,
defaultVersion,
displayName,
etag,
systemData,
tags,
type
FROM azure.batch.application
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND maxresults = '{{ maxresults }}'
;

INSERT examples

create

Adds an application to the specified Batch account.

INSERT INTO azure.batch.application (
properties,
tags,
resource_group_name,
account_name,
application_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ application_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: application
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the application resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the application resource.
  - name: application_name
    value: "{{ application_name }}"
    description: Required parameter for the application resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the application resource.
  - name: properties
    description: |
      The properties associated with the Application.
    value:
      displayName: "{{ displayName }}"
      allowUpdates: {{ allowUpdates }}
      defaultVersion: "{{ defaultVersion }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.

UPDATE examples

update

Updates settings for the specified application.

UPDATE azure.batch.application
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an application.

DELETE FROM azure.batch.application
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;