applications

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

Overview

Name	applications
Type	Resource
Id	azure.service_fabric.applications

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.
etag	string	Azure resource etag.
identity	object	The managed service identities assigned to this resource.
location	string	It will be deprecated in New API, resource location depends on the parent resource.
managedIdentities	array	List of user assigned identities for the application, each mapped to a friendly name.
maximumNodes	integer	The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.
metrics	array	List of application capacity metric description.
minimumNodes	integer	The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
parameters	object	List of application parameters with overridden values from their default values specified in the application manifest.
provisioningState	string	The current deployment or provisioning state, which only appears in the response.
removeApplicationCapacity	boolean	Remove the current application capacity settings.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Azure resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
typeName	string	The application type name as defined in the application manifest.
typeVersion	string	The version of the application type as defined in the application manifest.
upgradePolicy	object	Describes the policy for a monitored application upgrade.

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.
etag	string	Azure resource etag.
identity	object	The managed service identities assigned to this resource.
location	string	It will be deprecated in New API, resource location depends on the parent resource.
managedIdentities	array	List of user assigned identities for the application, each mapped to a friendly name.
maximumNodes	integer	The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.
metrics	array	List of application capacity metric description.
minimumNodes	integer	The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
parameters	object	List of application parameters with overridden values from their default values specified in the application manifest.
provisioningState	string	The current deployment or provisioning state, which only appears in the response.
removeApplicationCapacity	boolean	Remove the current application capacity settings.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Azure resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
typeName	string	The application type name as defined in the application manifest.
typeVersion	string	The version of the application type as defined in the application manifest.
upgradePolicy	object	Describes the policy for a monitored application upgrade.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, application_name, subscription_id		Gets a Service Fabric application resource. Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.
list	select	resource_group_name, cluster_name, subscription_id		Gets the list of application resources created in the specified Service Fabric cluster resource. Gets all application resources created or in the process of being created in the Service Fabric cluster resource.
create_or_update	insert	resource_group_name, cluster_name, application_name, subscription_id		Creates or updates a Service Fabric application resource. Create or update a Service Fabric application resource with the specified name.
update	update	resource_group_name, cluster_name, application_name, subscription_id		Updates a Service Fabric application resource. Update a Service Fabric application resource with the specified name.
create_or_update	replace	resource_group_name, cluster_name, application_name, subscription_id		Creates or updates a Service Fabric application resource. Create or update a Service Fabric application resource with the specified name.
delete	delete	resource_group_name, cluster_name, application_name, subscription_id		Deletes a Service Fabric application resource. Delete a Service Fabric application resource with the specified name.

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 name of the application resource. Required.
cluster_name	string	The name of the cluster resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a Service Fabric application resource. Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.

SELECT
id,
name,
etag,
identity,
location,
managedIdentities,
maximumNodes,
metrics,
minimumNodes,
parameters,
provisioningState,
removeApplicationCapacity,
systemData,
tags,
type,
typeName,
typeVersion,
upgradePolicy
FROM azure.service_fabric.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

Gets the list of application resources created in the specified Service Fabric cluster resource. Gets all application resources created or in the process of being created in the Service Fabric cluster resource.

SELECT
id,
name,
etag,
identity,
location,
managedIdentities,
maximumNodes,
metrics,
minimumNodes,
parameters,
provisioningState,
removeApplicationCapacity,
systemData,
tags,
type,
typeName,
typeVersion,
upgradePolicy
FROM azure.service_fabric.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Service Fabric application resource. Create or update a Service Fabric application resource with the specified name.

INSERT INTO azure.service_fabric.applications (
properties,
location,
tags,
identity,
resource_group_name,
cluster_name,
application_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ application_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
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 application resource properties.
    value:
      typeVersion: "{{ typeVersion }}"
      parameters: "{{ parameters }}"
      upgradePolicy:
        upgradeReplicaSetCheckTimeout: "{{ upgradeReplicaSetCheckTimeout }}"
        forceRestart: {{ forceRestart }}
        rollingUpgradeMonitoringPolicy:
          failureAction: "{{ failureAction }}"
          healthCheckWaitDuration: "{{ healthCheckWaitDuration }}"
          healthCheckStableDuration: "{{ healthCheckStableDuration }}"
          healthCheckRetryTimeout: "{{ healthCheckRetryTimeout }}"
          upgradeTimeout: "{{ upgradeTimeout }}"
          upgradeDomainTimeout: "{{ upgradeDomainTimeout }}"
        applicationHealthPolicy:
          considerWarningAsError: {{ considerWarningAsError }}
          maxPercentUnhealthyDeployedApplications: {{ maxPercentUnhealthyDeployedApplications }}
          defaultServiceTypeHealthPolicy:
            maxPercentUnhealthyServices: {{ maxPercentUnhealthyServices }}
            maxPercentUnhealthyPartitionsPerService: {{ maxPercentUnhealthyPartitionsPerService }}
            maxPercentUnhealthyReplicasPerPartition: {{ maxPercentUnhealthyReplicasPerPartition }}
          serviceTypeHealthPolicyMap: "{{ serviceTypeHealthPolicyMap }}"
        upgradeMode: "{{ upgradeMode }}"
        recreateApplication: {{ recreateApplication }}
      minimumNodes: {{ minimumNodes }}
      maximumNodes: {{ maximumNodes }}
      removeApplicationCapacity: {{ removeApplicationCapacity }}
      metrics:
        - name: "{{ name }}"
          maximumCapacity: {{ maximumCapacity }}
          reservationCapacity: {{ reservationCapacity }}
          totalApplicationCapacity: {{ totalApplicationCapacity }}
      managedIdentities:
        - name: "{{ name }}"
          principalId: "{{ principalId }}"
      provisioningState: "{{ provisioningState }}"
      typeName: "{{ typeName }}"
  - name: location
    value: "{{ location }}"
    description: |
      It will be deprecated in New API, resource location depends on the parent resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Azure resource tags.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates a Service Fabric application resource. Update a Service Fabric application resource with the specified name.

UPDATE azure.service_fabric.applications
SET 
location = '{{ location }}',
tags = '{{ tags }}',
systemData = '{{ systemData }}',
properties = '{{ properties }}'
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
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Service Fabric application resource. Create or update a Service Fabric application resource with the specified name.

REPLACE azure.service_fabric.applications
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
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
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Service Fabric application resource. Delete a Service Fabric application resource with the specified name.

DELETE FROM azure.service_fabric.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
;