relationships

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

Overview

Name	relationships
Type	Resource
Id	azure_extras.customer_insights.relationships

Fields

vw_relationships

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
description	text	field from the properties object
cardinality	text	field from the properties object
display_name	text	field from the properties object
expiry_date_time_utc	text	field from the properties object
fields	text	field from the properties object
hubName	text	field from the properties object
lookup_mappings	text	field from the properties object
profile_type	text	field from the properties object
provisioning_state	text	field from the properties object
related_profile_type	text	field from the properties object
relationshipName	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.

relationships

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

Methods

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

SELECT examples

Gets all relationships in the hub.

vw_relationships

SELECT
id,
name,
description,
cardinality,
display_name,
expiry_date_time_utc,
fields,
hubName,
lookup_mappings,
profile_type,
provisioning_state,
related_profile_type,
relationshipName,
relationship_guid_id,
relationship_name,
resourceGroupName,
subscriptionId,
tenant_id,
type
FROM azure_extras.customer_insights.vw_relationships
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

relationships

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: cardinality
          value: string
        - name: displayName
          value: object
        - name: description
          value: object
        - name: expiryDateTimeUtc
          value: string
        - name: fields
          value:
            - - name: arrayValueSeparator
                value: string
              - name: enumValidValues
                value:
                  - - name: value
                      value: integer
                    - name: localizedValueNames
                      value: object
              - name: fieldName
                value: string
              - name: fieldType
                value: string
              - name: isArray
                value: boolean
              - name: isEnum
                value: boolean
              - name: isFlagEnum
                value: boolean
              - name: isImage
                value: boolean
              - name: isLocalizedString
                value: boolean
              - name: isName
                value: boolean
              - name: isRequired
                value: boolean
              - name: propertyId
                value: string
              - name: schemaItemPropLink
                value: string
              - name: maxLength
                value: integer
              - name: isAvailableInGraph
                value: boolean
              - name: dataSourcePrecedenceRules
                value:
                  - - name: dataSource
                      value:
                        - name: name
                          value: string
                        - name: dataSourceType
                          value: string
                        - name: status
                          value: string
                        - name: id
                          value: integer
                        - name: dataSourceReferenceId
                          value: string
                    - name: precedence
                      value: integer
        - name: lookupMappings
          value:
            - - name: fieldMappings
                value:
                  - - name: profileFieldName
                      value: string
                    - name: relatedProfileKeyProperty
                      value: string
        - name: profileType
          value: string
        - name: provisioningState
          value: []
        - name: relationshipName
          value: string
        - name: relatedProfileType
          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 relationships resource.

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