application_live_views

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

Overview

Name	application_live_views
Type	Resource
Id	azure_extras.app_platform.application_live_views

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.
components	array	Component details of Application Live View.
provisioningState	string	State of the Application Live View. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
components	array	Component details of Application Live View.
provisioningState	string	State of the Application Live View. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, application_live_view_name, subscription_id		Get the Application Live 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, application_live_view_name, subscription_id		Create the default Application Live View or update the existing Application Live View.
create_or_update	replace	resource_group_name, service_name, application_live_view_name, subscription_id		Create the default Application Live View or update the existing Application Live View.
delete	delete	resource_group_name, service_name, application_live_view_name, subscription_id		Disable the default Application Live View.

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_live_view_name	string	The name of Application Live View. 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

SELECT examples

get

Get the Application Live and its properties.

SELECT
id,
name,
components,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.application_live_views
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND application_live_view_name = '{{ application_live_view_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handles requests to list all resources in a Service.

SELECT
id,
name,
components,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.application_live_views
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 the default Application Live View or update the existing Application Live View.

INSERT INTO azure_extras.app_platform.application_live_views (
properties,
resource_group_name,
service_name,
application_live_view_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ application_live_view_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: application_live_views
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the application_live_views resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the application_live_views resource.
  - name: application_live_view_name
    value: "{{ application_live_view_name }}"
    description: Required parameter for the application_live_views resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the application_live_views resource.
  - name: properties
    description: |
      Application Live View properties payload.
    value:
      provisioningState: "{{ provisioningState }}"
      components:
        - name: "{{ name }}"
          resourceRequests:
            cpu: "{{ cpu }}"
            memory: "{{ memory }}"
            instanceCount: {{ instanceCount }}
          instances: "{{ instances }}"

REPLACE examples

create_or_update

Create the default Application Live View or update the existing Application Live View.

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

DELETE examples

delete

Disable the default Application Live View.

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