views

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

Overview

Name	views
Type	Resource
Id	azure_extras.customer_insights.views

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the view.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The view in Customer 360 web application.
type	string	Resource type.

list_by_hub

OK. Successfully get all the views in the hub for the given user.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The view in Customer 360 web application.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hubName, viewName, subscriptionId, userId		Gets a view in the hub.
list_by_hub	select	resourceGroupName, hubName, subscriptionId, userId		Gets all available views for given user in the specified hub.
create_or_update	insert	resourceGroupName, hubName, viewName, subscriptionId		Creates a view or updates an existing view in the hub.
delete	delete	resourceGroupName, hubName, viewName, subscriptionId, userId		Deletes a view in the specified hub.

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
hubName	string	The name of the hub.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
userId	string	The user ID. Use * to retrieve hub level view.
viewName	string	The name of the view.

SELECT examples

get

Gets a view in the hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.views
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND viewName = '{{ viewName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND userId = '{{ userId }}' -- required
;

list_by_hub

Gets all available views for given user in the specified hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.views
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND userId = '{{ userId }}' -- required
;

INSERT examples

create_or_update

Creates a view or updates an existing view in the hub.

INSERT INTO azure_extras.customer_insights.views (
data__properties,
resourceGroupName,
hubName,
viewName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ hubName }}',
'{{ viewName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: views
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the views resource.
    - name: hubName
      value: string
      description: Required parameter for the views resource.
    - name: viewName
      value: string
      description: Required parameter for the views resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the views resource.
    - name: properties
      value: object
      description: |
        The view in Customer 360 web application.

DELETE examples

delete

Deletes a view in the specified hub.

DELETE FROM azure_extras.customer_insights.views
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND viewName = '{{ viewName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND userId = '{{ userId }}' --required
;