interactions

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

Overview

Name	interactions
Type	Resource
Id	azure_extras.customer_insights.interactions

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the interaction.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The Interaction Type Definition
type	string	Resource type.

list_by_hub

OK. Successfully get all the interactions in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The Interaction Type Definition
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, interactionName, subscriptionId	locale-code	Gets information about the specified interaction.
list_by_hub	select	resourceGroupName, hubName, subscriptionId	locale-code	Gets all interactions in the hub.
create_or_update	insert	resourceGroupName, hubName, interactionName, subscriptionId		Creates an interaction or updates an existing interaction within a hub.
suggest_relationship_links	exec	resourceGroupName, hubName, interactionName, subscriptionId		Suggests relationships to create relationship links.

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.
interactionName	string	The name of the interaction.
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.
locale-code	string	Locale of interaction to retrieve, default is en-us.

SELECT examples

get

Gets information about the specified interaction.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.interactions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND interactionName = '{{ interactionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND locale-code = '{{ locale-code }}'
;

list_by_hub

Gets all interactions in the hub.

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

INSERT examples

create_or_update

Creates an interaction or updates an existing interaction within a hub.

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

Manifest

# Description fields are for documentation purposes
- name: interactions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the interactions resource.
    - name: hubName
      value: string
      description: Required parameter for the interactions resource.
    - name: interactionName
      value: string
      description: Required parameter for the interactions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the interactions resource.
    - name: properties
      value: object
      description: |
        The Interaction Type Definition

Lifecycle Methods

suggest_relationship_links

Suggests relationships to create relationship links.

EXEC azure_extras.customer_insights.interactions.suggest_relationship_links 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hubName='{{ hubName }}' --required, 
@interactionName='{{ interactionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;