applications

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

Overview

Name	applications
Type	Resource
Id	azure.service_fabric_managed_clusters.applications

Fields

The following fields are returned by SELECT queries:

get

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
identity	object	Describes the managed identities for an Azure resource.
location	string	Resource location depends on the parent resource.
properties	object	The application resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

list

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
identity	object	Describes the managed identities for an Azure resource.
location	string	Resource location depends on the parent resource.
properties	object	The application resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Get a Service Fabric managed application resource created or in the process of being created in the Service Fabric cluster resource.
list	select	subscriptionId, resourceGroupName, clusterName	api-version	Gets all managed application resources created or in the process of being created in the Service Fabric cluster resource.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Create or update a Service Fabric managed application resource with the specified name.
update	update	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Updates the tags of an application resource of a given managed cluster.
delete	delete	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Delete a Service Fabric managed application resource with the specified name.
read_upgrade	exec	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Get the status of the latest application upgrade. It will query the cluster to find the status of the latest application upgrade.
start_rollback	exec	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Send a request to start a rollback of the current application upgrade. This will start rolling back the application to the previous version.
resume_upgrade	exec	subscriptionId, resourceGroupName, clusterName, applicationName	api-version	Send a request to resume the current application upgrade. This will resume the application upgrade from where it was paused.

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
applicationName	string	The name of the application resource.
clusterName	string	The name of the cluster resource.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The customer subscription identifier.
api-version	string	The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2024-06-01-preview" for this specification.

SELECT examples

get

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

SELECT
id,
name,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.service_fabric_managed_clusters.applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND applicationName = '{{ applicationName }}' -- required
AND api-version = '{{ api-version }}'
;

list

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

SELECT
id,
name,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.service_fabric_managed_clusters.applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.service_fabric_managed_clusters.applications (
data__identity,
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
clusterName,
applicationName,
api-version
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ applicationName }}',
'{{ api-version }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: applications
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the applications resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the applications resource.
    - name: clusterName
      value: string
      description: Required parameter for the applications resource.
    - name: applicationName
      value: string
      description: Required parameter for the applications resource.
    - name: identity
      value: object
      description: |
        Describes the managed identities for an Azure resource.
    - name: properties
      value: object
      description: |
        The application resource properties.
    - name: location
      value: string
      description: |
        Resource location depends on the parent resource.
    - name: tags
      value: object
      description: |
        Azure resource tags.
    - name: api-version
      value: string
      description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2024-06-01-preview" for this specification.

UPDATE examples

update

Updates the tags of an application resource of a given managed cluster.

UPDATE azure.service_fabric_managed_clusters.applications
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND applicationName = '{{ applicationName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

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

DELETE FROM azure.service_fabric_managed_clusters.applications
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND applicationName = '{{ applicationName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

read_upgrade

Get the status of the latest application upgrade. It will query the cluster to find the status of the latest application upgrade.

EXEC azure.service_fabric_managed_clusters.applications.read_upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@applicationName='{{ applicationName }}' --required, 
@api-version='{{ api-version }}'
;

start_rollback

Send a request to start a rollback of the current application upgrade. This will start rolling back the application to the previous version.

EXEC azure.service_fabric_managed_clusters.applications.start_rollback 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@applicationName='{{ applicationName }}' --required, 
@api-version='{{ api-version }}'
;

resume_upgrade

Send a request to resume the current application upgrade. This will resume the application upgrade from where it was paused.

EXEC azure.service_fabric_managed_clusters.applications.resume_upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@applicationName='{{ applicationName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"upgradeDomainName": "{{ upgradeDomainName }}"
}'
;