apps

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

Overview

Name	apps
Type	Resource
Id	azure_extras.app_platform.apps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
addonConfigs	object	Collection of addons.
customPersistentDisks	array	List of custom persistent disks.
enableEndToEndTLS	boolean	Indicate if end to end TLS is enabled.
fqdn	string	Fully qualified dns Name.
httpsOnly	boolean	Indicate if only https is allowed.
identity	object	The Managed Identity type of the app resource.
ingressSettings	object	App ingress settings payload.
loadedCertificates	array	Collection of loaded certificates.
location	string	The GEO location of the application, always the same with its parent resource.
persistentDisk	object	Persistent disk settings.
provisioningState	string	Provisioning state of the App. Known values are: "Succeeded", "Failed", "Creating", "Updating", and "Deleting".
public	boolean	Indicates whether the App exposes public endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
temporaryDisk	object	Temporary disk settings.
type	string	The type of the resource.
url	string	URL of the App.
vnetAddons	object	Additional App settings in vnet injection instance.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
addonConfigs	object	Collection of addons.
customPersistentDisks	array	List of custom persistent disks.
enableEndToEndTLS	boolean	Indicate if end to end TLS is enabled.
fqdn	string	Fully qualified dns Name.
httpsOnly	boolean	Indicate if only https is allowed.
identity	object	The Managed Identity type of the app resource.
ingressSettings	object	App ingress settings payload.
loadedCertificates	array	Collection of loaded certificates.
location	string	The GEO location of the application, always the same with its parent resource.
persistentDisk	object	Persistent disk settings.
provisioningState	string	Provisioning state of the App. Known values are: "Succeeded", "Failed", "Creating", "Updating", and "Deleting".
public	boolean	Indicates whether the App exposes public endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
temporaryDisk	object	Temporary disk settings.
type	string	The type of the resource.
url	string	URL of the App.
vnetAddons	object	Additional App settings in vnet injection instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, app_name, subscription_id	syncStatus	Get an App and its properties.
list	select	resource_group_name, service_name, subscription_id		Handles requests to list all resources in a Service.
create_or_update	insert	resource_group_name, service_name, app_name, subscription_id		Create a new App or update an exiting App.
update	update	resource_group_name, service_name, app_name, subscription_id		Operation to update an exiting App.
create_or_update	replace	resource_group_name, service_name, app_name, subscription_id		Create a new App or update an exiting App.
delete	delete	resource_group_name, service_name, app_name, subscription_id		Operation to delete an App.
get_resource_upload_url	exec	resource_group_name, service_name, app_name, subscription_id		Get an resource upload URL for an App, which may be artifacts or source archive.
set_active_deployments	exec	resource_group_name, service_name, app_name, subscription_id		Set existing Deployment under the app as active.
validate_domain	exec	resource_group_name, service_name, app_name, subscription_id, 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
app_name	string	The name of the App resource. Required.
resource_group_name	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. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string
syncStatus	string	Indicates whether sync status. Default value is None.

SELECT examples

get

Get an App and its properties.

SELECT
id,
name,
addonConfigs,
customPersistentDisks,
enableEndToEndTLS,
fqdn,
httpsOnly,
identity,
ingressSettings,
loadedCertificates,
location,
persistentDisk,
provisioningState,
public,
systemData,
temporaryDisk,
type,
url,
vnetAddons
FROM azure_extras.app_platform.apps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND syncStatus = '{{ syncStatus }}'
;

list

Handles requests to list all resources in a Service.

SELECT
id,
name,
addonConfigs,
customPersistentDisks,
enableEndToEndTLS,
fqdn,
httpsOnly,
identity,
ingressSettings,
loadedCertificates,
location,
persistentDisk,
provisioningState,
public,
systemData,
temporaryDisk,
type,
url,
vnetAddons
FROM azure_extras.app_platform.apps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a new App or update an exiting App.

INSERT INTO azure_extras.app_platform.apps (
properties,
identity,
location,
resource_group_name,
service_name,
app_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ app_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: apps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the apps resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the apps resource.
  - name: app_name
    value: "{{ app_name }}"
    description: Required parameter for the apps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the apps resource.
  - name: properties
    description: |
      Properties of the App resource.
    value:
      public: {{ public }}
      url: "{{ url }}"
      addonConfigs: "{{ addonConfigs }}"
      provisioningState: "{{ provisioningState }}"
      fqdn: "{{ fqdn }}"
      httpsOnly: {{ httpsOnly }}
      temporaryDisk:
        sizeInGB: {{ sizeInGB }}
        mountPath: "{{ mountPath }}"
      persistentDisk:
        sizeInGB: {{ sizeInGB }}
        usedInGB: {{ usedInGB }}
        mountPath: "{{ mountPath }}"
      customPersistentDisks:
        - customPersistentDiskProperties:
            type: "{{ type }}"
            mountPath: "{{ mountPath }}"
            readOnly: {{ readOnly }}
            enableSubPath: {{ enableSubPath }}
            mountOptions:
              - "{{ mountOptions }}"
          storageId: "{{ storageId }}"
      enableEndToEndTLS: {{ enableEndToEndTLS }}
      loadedCertificates:
        - resourceId: "{{ resourceId }}"
          loadTrustStore: {{ loadTrustStore }}
      vnetAddons:
        publicEndpoint: {{ publicEndpoint }}
        publicEndpointUrl: "{{ publicEndpointUrl }}"
      ingressSettings:
        readTimeoutInSeconds: {{ readTimeoutInSeconds }}
        sendTimeoutInSeconds: {{ sendTimeoutInSeconds }}
        sessionAffinity: "{{ sessionAffinity }}"
        sessionCookieMaxAge: {{ sessionCookieMaxAge }}
        backendProtocol: "{{ backendProtocol }}"
        clientAuth:
          certificates:
            - "{{ certificates }}"
  - name: identity
    description: |
      The Managed Identity type of the app resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: location
    value: "{{ location }}"
    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_extras.app_platform.apps
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a new App or update an exiting App.

REPLACE azure_extras.app_platform.apps
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type;

DELETE examples

delete

Operation to delete an App.

DELETE FROM azure_extras.app_platform.apps
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_resource_upload_url

Get an resource upload URL for an App, which may be artifacts or source archive.

EXEC azure_extras.app_platform.apps.get_resource_upload_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

set_active_deployments

Set existing Deployment under the app as active.

EXEC azure_extras.app_platform.apps.set_active_deployments 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"activeDeploymentNames": "{{ activeDeploymentNames }}"
}'
;

validate_domain

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

EXEC azure_extras.app_platform.apps.validate_domain 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;