applications

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

Overview

Name	applications
Type	Resource
Id	azure.hdinsight.applications

Fields

The following fields are returned by SELECT queries:

get_azure_async_operation_status

Name	Datatype	Description
error	object	The error message associated with the cluster creation.
status	string	The async operation state. Known values are: "InProgress", "Succeeded", and "Failed". (InProgress, Succeeded, Failed)

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.
applicationState	string	The application state.
applicationType	string	The application type.
computeProfile	object	The list of roles in the cluster.
createdDate	string	The application create date time.
errors	array	The list of errors.
etag	string	The ETag for the application.
httpsEndpoints	array	The list of application HTTPS endpoints.
installScriptActions	array	The list of install script actions.
marketplaceIdentifier	string	The marketplace identifier.
privateLinkConfigurations	array	The private link configurations.
provisioningState	string	The provisioning state of the application.
sshEndpoints	array	The list of application SSH endpoints.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags for the application.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uninstallScriptActions	array	The list of uninstall script actions.

list_by_cluster

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.
applicationState	string	The application state.
applicationType	string	The application type.
computeProfile	object	The list of roles in the cluster.
createdDate	string	The application create date time.
errors	array	The list of errors.
etag	string	The ETag for the application.
httpsEndpoints	array	The list of application HTTPS endpoints.
installScriptActions	array	The list of install script actions.
marketplaceIdentifier	string	The marketplace identifier.
privateLinkConfigurations	array	The private link configurations.
provisioningState	string	The provisioning state of the application.
sshEndpoints	array	The list of application SSH endpoints.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags for the application.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uninstallScriptActions	array	The list of uninstall script actions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_azure_async_operation_status	select	resource_group_name, cluster_name, application_name, operation_id, subscription_id		Gets the async operation status.
get	select	resource_group_name, cluster_name, application_name, subscription_id		Gets properties of the specified application.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Lists all of the applications for the HDInsight cluster.
create	insert	resource_group_name, cluster_name, application_name, subscription_id		Creates applications for the HDInsight cluster.
delete	delete	resource_group_name, cluster_name, application_name, subscription_id		Deletes the specified application on the HDInsight cluster.

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
application_name	string	The constant value for the application name. Required.
cluster_name	string	The name of the cluster. Required.
operation_id	string	The long running operation id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_azure_async_operation_status

Gets the async operation status.

SELECT
error,
status
FROM azure.hdinsight.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND application_name = '{{ application_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets properties of the specified application.

SELECT
id,
name,
applicationState,
applicationType,
computeProfile,
createdDate,
errors,
etag,
httpsEndpoints,
installScriptActions,
marketplaceIdentifier,
privateLinkConfigurations,
provisioningState,
sshEndpoints,
systemData,
tags,
type,
uninstallScriptActions
FROM azure.hdinsight.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND application_name = '{{ application_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Lists all of the applications for the HDInsight cluster.

SELECT
id,
name,
applicationState,
applicationType,
computeProfile,
createdDate,
errors,
etag,
httpsEndpoints,
installScriptActions,
marketplaceIdentifier,
privateLinkConfigurations,
provisioningState,
sshEndpoints,
systemData,
tags,
type,
uninstallScriptActions
FROM azure.hdinsight.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates applications for the HDInsight cluster.

INSERT INTO azure.hdinsight.applications (
properties,
etag,
tags,
resource_group_name,
cluster_name,
application_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ application_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the applications resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the applications resource.
  - name: application_name
    value: "{{ application_name }}"
    description: Required parameter for the applications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the applications resource.
  - name: properties
    description: |
      The properties of the application.
    value:
      computeProfile:
        roles:
          - name: "{{ name }}"
            minInstanceCount: {{ minInstanceCount }}
            targetInstanceCount: {{ targetInstanceCount }}
            VMGroupName: "{{ VMGroupName }}"
            autoscale:
              capacity:
                minInstanceCount: {{ minInstanceCount }}
                maxInstanceCount: {{ maxInstanceCount }}
              recurrence:
                timeZone: "{{ timeZone }}"
                schedule: "{{ schedule }}"
            hardwareProfile:
              vmSize: "{{ vmSize }}"
            osProfile:
              linuxOperatingSystemProfile:
                username: "{{ username }}"
                password: "{{ password }}"
                sshProfile: "{{ sshProfile }}"
            virtualNetworkProfile:
              id: "{{ id }}"
              subnet: "{{ subnet }}"
            dataDisksGroups: "{{ dataDisksGroups }}"
            scriptActions: "{{ scriptActions }}"
            encryptDataDisks: {{ encryptDataDisks }}
      installScriptActions:
        - name: "{{ name }}"
          uri: "{{ uri }}"
          parameters: "{{ parameters }}"
          roles: "{{ roles }}"
          applicationName: "{{ applicationName }}"
      uninstallScriptActions:
        - name: "{{ name }}"
          uri: "{{ uri }}"
          parameters: "{{ parameters }}"
          roles: "{{ roles }}"
          applicationName: "{{ applicationName }}"
      httpsEndpoints:
        - accessModes: "{{ accessModes }}"
          location: "{{ location }}"
          destinationPort: {{ destinationPort }}
          publicPort: {{ publicPort }}
          privateIPAddress: "{{ privateIPAddress }}"
          subDomainSuffix: "{{ subDomainSuffix }}"
          disableGatewayAuth: {{ disableGatewayAuth }}
      sshEndpoints:
        - location: "{{ location }}"
          destinationPort: {{ destinationPort }}
          publicPort: {{ publicPort }}
          privateIPAddress: "{{ privateIPAddress }}"
      provisioningState: "{{ provisioningState }}"
      applicationType: "{{ applicationType }}"
      applicationState: "{{ applicationState }}"
      errors:
        - code: "{{ code }}"
          message: "{{ message }}"
      createdDate: "{{ createdDate }}"
      marketplaceIdentifier: "{{ marketplaceIdentifier }}"
      privateLinkConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            groupId: "{{ groupId }}"
            provisioningState: "{{ provisioningState }}"
            ipConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  provisioningState: "{{ provisioningState }}"
                  primary: {{ primary }}
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      The ETag for the application.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags for the application.

DELETE examples

delete

Deletes the specified application on the HDInsight cluster.

DELETE FROM azure.hdinsight.applications
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;