relationship_links

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

Overview

Name	relationship_links
Type	Resource
Id	azure_extras.customer_insights.relationship_links

Fields

vw_relationship_links

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
description	text	field from the properties object
display_name	text	field from the properties object
hubName	text	field from the properties object
interaction_type	text	field from the properties object
link_name	text	field from the properties object
mappings	text	field from the properties object
profile_property_references	text	field from the properties object
provisioning_state	text	field from the properties object
related_profile_property_references	text	field from the properties object
relationshipLinkName	text	field from the properties object
relationship_guid_id	text	field from the properties object
relationship_name	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tenant_id	text	field from the properties object
type	text	Resource type.

relationship_links

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The definition of relationship link.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hubName, relationshipLinkName, resourceGroupName, subscriptionId	Gets information about the specified relationship Link.
list_by_hub	SELECT	hubName, resourceGroupName, subscriptionId	Gets all relationship links in the hub.
create_or_update	INSERT	hubName, relationshipLinkName, resourceGroupName, subscriptionId	Creates a relationship link or updates an existing relationship link within a hub.
delete	DELETE	hubName, relationshipLinkName, resourceGroupName, subscriptionId	Deletes a relationship link within a hub.

SELECT examples

Gets all relationship links in the hub.

vw_relationship_links

SELECT
id,
name,
description,
display_name,
hubName,
interaction_type,
link_name,
mappings,
profile_property_references,
provisioning_state,
related_profile_property_references,
relationshipLinkName,
relationship_guid_id,
relationship_name,
resourceGroupName,
subscriptionId,
tenant_id,
type
FROM azure_extras.customer_insights.vw_relationship_links
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

relationship_links

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

INSERT example

Use the following StackQL query and manifest file to create a new relationship_links resource.

All Properties

/*+ create */
INSERT INTO azure_extras.customer_insights.relationship_links (
hubName,
relationshipLinkName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ hubName }}',
'{{ relationshipLinkName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: object
        - name: description
          value: object
        - name: interactionType
          value: string
        - name: linkName
          value: string
        - name: mappings
          value:
            - - name: interactionFieldName
                value: string
              - name: linkType
                value: string
              - name: relationshipFieldName
                value: string
        - name: profilePropertyReferences
          value:
            - - name: interactionPropertyName
                value: string
              - name: profilePropertyName
                value: string
        - name: provisioningState
          value: []
        - name: relatedProfilePropertyReferences
          value:
            - - name: interactionPropertyName
                value: string
              - name: profilePropertyName
                value: string
        - name: relationshipName
          value: string
        - name: relationshipGuidId
          value: string
        - name: tenantId
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

DELETE example

Deletes the specified relationship_links resource.

/*+ delete */
DELETE FROM azure_extras.customer_insights.relationship_links
WHERE hubName = '{{ hubName }}'
AND relationshipLinkName = '{{ relationshipLinkName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';