applications

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

Overview

Name	applications
Type	Resource
Id	azure.service_fabric_dataplane.applications

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_application	insert	endpoint, Name, TypeName, TypeVersion	timeout	Creates a Service Fabric application. Creates a Service Fabric application using the specified description.
delete_application	delete	application_id, endpoint	ForceRemove, timeout	Deletes an existing Service Fabric application. An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.
update_application	exec	application_id, endpoint	timeout	Updates a Service Fabric application. Updates a Service Fabric application instance. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the 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
application_id	string	The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myappapp1" in 6.0+ and "myapp/app1" in previous versions.
endpoint	string	The service endpoint host (no scheme). (default: )
ForceRemove	boolean	Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
timeout	integer (int64)	The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

INSERT examples

create_application

Creates a Service Fabric application. Creates a Service Fabric application using the specified description.

INSERT INTO azure.service_fabric_dataplane.applications (
Name,
TypeName,
TypeVersion,
ParameterList,
ApplicationCapacity,
ManagedApplicationIdentity,
endpoint,
timeout
)
SELECT 
'{{ Name }}' /* required */,
'{{ TypeName }}' /* required */,
'{{ TypeVersion }}' /* required */,
'{{ ParameterList }}',
'{{ ApplicationCapacity }}',
'{{ ManagedApplicationIdentity }}',
'{{ endpoint }}',
'{{ timeout }}'
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the applications resource.
  - name: Name
    value: "{{ Name }}"
  - name: TypeName
    value: "{{ TypeName }}"
  - name: TypeVersion
    value: "{{ TypeVersion }}"
  - name: ParameterList
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ApplicationCapacity
    description: |
      Describes capacity information for services of this application. This description can be used for describing the following. - Reserving the capacity for the services on the nodes - Limiting the total number of nodes that services of this application can run on - Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application.
    value:
      MinimumNodes: {{ MinimumNodes }}
      MaximumNodes: {{ MaximumNodes }}
      ApplicationMetrics:
        - Name: "{{ Name }}"
          MaximumCapacity: {{ MaximumCapacity }}
          ReservationCapacity: {{ ReservationCapacity }}
          TotalApplicationCapacity: {{ TotalApplicationCapacity }}
  - name: ManagedApplicationIdentity
    description: |
      Managed application identity description.
    value:
      TokenServiceEndpoint: "{{ TokenServiceEndpoint }}"
      ManagedIdentities:
        - Name: "{{ Name }}"
          PrincipalId: "{{ PrincipalId }}"
  - name: timeout
    value: "{{ timeout }}"
    description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
    description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

DELETE examples

delete_application

Deletes an existing Service Fabric application. An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.

DELETE FROM azure.service_fabric_dataplane.applications
WHERE application_id = '{{ application_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ForceRemove = '{{ ForceRemove }}'
AND timeout = '{{ timeout }}'
;

Lifecycle Methods

update_application

Updates a Service Fabric application. Updates a Service Fabric application instance. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the application.

EXEC azure.service_fabric_dataplane.applications.update_application 
@application_id='{{ application_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@timeout='{{ timeout }}' 
@@json=
'{
"Flags": "{{ Flags }}", 
"RemoveApplicationCapacity": {{ RemoveApplicationCapacity }}, 
"MinimumNodes": {{ MinimumNodes }}, 
"MaximumNodes": {{ MaximumNodes }}, 
"ApplicationMetrics": "{{ ApplicationMetrics }}"
}'
;