apps

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

Overview

Name	apps
Type	Resource
Id	azure.spring_apps.apps

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding App.

Name	Datatype	Description
identity	object	The Managed Identity type of the app resource
location	string	The GEO location of the application, always the same with its parent resource
properties	object	Properties of the App resource

list

Success. The response describes the list of Apps in the Service.

Name	Datatype	Description
identity	object	The Managed Identity type of the app resource
location	string	The GEO location of the application, always the same with its parent resource
properties	object	Properties of the App resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, appName	syncStatus	Get an App and its properties.
list	select	subscriptionId, resourceGroupName, serviceName		Handles requests to list all resources in a Service.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, appName		Create a new App or update an exiting App.
update	update	subscriptionId, resourceGroupName, serviceName, appName		Operation to update an exiting App.
delete	delete	subscriptionId, resourceGroupName, serviceName, appName		Operation to delete an App.
set_active_deployments	exec	subscriptionId, resourceGroupName, serviceName, appName		Set existing Deployment under the app as active
validate_domain	exec	subscriptionId, resourceGroupName, serviceName, appName, name		Check the resource name is valid as well as not in use.

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
appName	string	The name of the App resource.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
syncStatus	string	Indicates whether sync status

SELECT examples

get

Get an App and its properties.

SELECT
identity,
location,
properties
FROM azure.spring_apps.apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND appName = '{{ appName }}' -- required
AND syncStatus = '{{ syncStatus }}'
;

list

Handles requests to list all resources in a Service.

SELECT
identity,
location,
properties
FROM azure.spring_apps.apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

INSERT examples

create_or_update

Create a new App or update an exiting App.

INSERT INTO azure.spring_apps.apps (
data__properties,
data__identity,
data__location,
subscriptionId,
resourceGroupName,
serviceName,
appName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ appName }}'
RETURNING
identity,
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: apps
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the apps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the apps resource.
    - name: serviceName
      value: string
      description: Required parameter for the apps resource.
    - name: appName
      value: string
      description: Required parameter for the apps resource.
    - name: properties
      value: object
      description: |
        Properties of the App resource
    - name: identity
      value: object
      description: |
        The Managed Identity type of the app resource
    - name: location
      value: string
      description: |
        The GEO location of the application, always the same with its parent resource

UPDATE examples

update

Operation to update an exiting App.

UPDATE azure.spring_apps.apps
SET 
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__location = '{{ location }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND appName = '{{ appName }}' --required
RETURNING
identity,
location,
properties;

DELETE examples

delete

Operation to delete an App.

DELETE FROM azure.spring_apps.apps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND appName = '{{ appName }}' --required
;

Lifecycle Methods

set_active_deployments

Set existing Deployment under the app as active

EXEC azure.spring_apps.apps.set_active_deployments 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required 
@@json=
'{
"activeDeploymentNames": "{{ activeDeploymentNames }}"
}'
;

validate_domain

Check the resource name is valid as well as not in use.

EXEC azure.spring_apps.apps.validate_domain 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;