mesh_application

Creates, updates, deletes, gets or lists a mesh_application resource.

Overview

Name	mesh_application
Type	Resource
Id	azure.service_fabric_dataplane.mesh_application

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
debugParams	string
description	string
diagnostics	object	Describes the diagnostics options available.
healthState	string	Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
identity	object	Information describing the identities associated with this application. All required parameters must be populated in order to send to Azure.
serviceNames	array	Names of the services in the application.
services	array
status	string	Status of the application. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
statusDetails	string	Gives additional information about the current status of the application.
unhealthyEvaluation	string	When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy.

list

Name	Datatype	Description
ContinuationToken	string
Items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	application_resource_name, endpoint		Gets the Application resource with the given name. Gets the information about the Application resource with the given name. The information include the description and other properties of the Application.
list	select	endpoint		Lists all the application resources. Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.
create_or_update	insert	application_resource_name, endpoint, name		Creates or updates a Application resource. Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.
create_or_update	replace	application_resource_name, endpoint, name		Creates or updates a Application resource. Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.
delete	delete	application_resource_name, endpoint		Deletes the Application resource. Deletes the Application resource identified by the name.
get_upgrade_progress	exec	application_resource_name, endpoint		Gets the progress of the latest upgrade performed on this application resource. Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade state information of the Application resource.

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_resource_name	string	The identity of the application.
endpoint	string	The service endpoint host (no scheme). (default: )

SELECT examples

get

Gets the Application resource with the given name. Gets the information about the Application resource with the given name. The information include the description and other properties of the Application.

SELECT
name,
debugParams,
description,
diagnostics,
healthState,
identity,
serviceNames,
services,
status,
statusDetails,
unhealthyEvaluation
FROM azure.service_fabric_dataplane.mesh_application
WHERE application_resource_name = '{{ application_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

Lists all the application resources. Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.

SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.mesh_application
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Application resource. Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.

INSERT INTO azure.service_fabric_dataplane.mesh_application (
name,
properties,
identity,
application_resource_name,
endpoint
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ application_resource_name }}',
'{{ endpoint }}'
RETURNING
name,
identity,
properties
;

Manifest

# Description fields are for documentation purposes
- name: mesh_application
props:
  - name: application_resource_name
    value: "{{ application_resource_name }}"
    description: Required parameter for the mesh_application resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the mesh_application resource.
  - name: name
    value: "{{ name }}"
  - name: properties
    value:
      description: "{{ description }}"
      services:
        - name: "{{ name }}"
          properties:
            osType: "{{ osType }}"
            codePackages:
              - name: "{{ name }}"
                image: "{{ image }}"
                imageRegistryCredential:
                  server: "{{ server }}"
                  username: "{{ username }}"
                  passwordType: "{{ passwordType }}"
                  password: "{{ password }}"
                entryPoint: "{{ entryPoint }}"
                commands: "{{ commands }}"
                environmentVariables: "{{ environmentVariables }}"
                settings: "{{ settings }}"
                labels: "{{ labels }}"
                endpoints: "{{ endpoints }}"
                resources:
                  requests: "{{ requests }}"
                  limits: "{{ limits }}"
                volumeRefs: "{{ volumeRefs }}"
                volumes: "{{ volumes }}"
                diagnostics:
                  enabled: {{ enabled }}
                  sinkRefs: "{{ sinkRefs }}"
                reliableCollectionsRefs: "{{ reliableCollectionsRefs }}"
                instanceView:
                  restartCount: {{ restartCount }}
                  currentState: "{{ currentState }}"
                  previousState: "{{ previousState }}"
                  events: "{{ events }}"
                livenessProbe: "{{ livenessProbe }}"
                readinessProbe: "{{ readinessProbe }}"
            networkRefs:
              - name: "{{ name }}"
                endpointRefs: "{{ endpointRefs }}"
            diagnostics:
              enabled: {{ enabled }}
              sinkRefs:
                - "{{ sinkRefs }}"
            description: "{{ description }}"
            replicaCount: {{ replicaCount }}
            executionPolicy:
              type: "{{ type }}"
            autoScalingPolicies:
              - name: "{{ name }}"
                trigger:
                  kind: "{{ kind }}"
                mechanism:
                  kind: "{{ kind }}"
            status: "{{ status }}"
            statusDetails: "{{ statusDetails }}"
            healthState: "{{ healthState }}"
            unhealthyEvaluation: "{{ unhealthyEvaluation }}"
            identityRefs:
              - name: "{{ name }}"
                identityRef: "{{ identityRef }}"
            dnsName: "{{ dnsName }}"
      diagnostics:
        sinks:
          - name: "{{ name }}"
            description: "{{ description }}"
            kind: "{{ kind }}"
        enabled: {{ enabled }}
        defaultSinkRefs:
          - "{{ defaultSinkRefs }}"
      debugParams: "{{ debugParams }}"
  - name: identity
    description: |
      Information describing the identities associated with this application. All required parameters must be populated in order to send to Azure.
    value:
      tokenServiceEndpoint: "{{ tokenServiceEndpoint }}"
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

REPLACE examples

create_or_update

Creates or updates a Application resource. Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.

REPLACE azure.service_fabric_dataplane.mesh_application
SET 
name = '{{ name }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
application_resource_name = '{{ application_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
identity,
properties;

DELETE examples

delete

Deletes the Application resource. Deletes the Application resource identified by the name.

DELETE FROM azure.service_fabric_dataplane.mesh_application
WHERE application_resource_name = '{{ application_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_upgrade_progress

Gets the progress of the latest upgrade performed on this application resource. Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade state information of the Application resource.

EXEC azure.service_fabric_dataplane.mesh_application.get_upgrade_progress 
@application_resource_name='{{ application_resource_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;