relationships

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

Overview

Name	relationships
Type	Resource
Id	azure_extras.customer_insights.relationships

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the relationship.

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

list_by_hub

OK. Successfully get all the relationships in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The definition of Relationship.
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, relationshipName, subscriptionId		Gets information about the specified relationship.
list_by_hub	select	resourceGroupName, hubName, subscriptionId		Gets all relationships in the hub.
create_or_update	insert	resourceGroupName, hubName, relationshipName, subscriptionId		Creates a relationship or updates an existing relationship within a hub.
delete	delete	resourceGroupName, hubName, relationshipName, subscriptionId		Deletes a relationship within a 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.
relationshipName	string	The name of the relationship.
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.

SELECT examples

get

Gets information about the specified relationship.

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

list_by_hub

Gets all relationships in the hub.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: relationships
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the relationships resource.
    - name: hubName
      value: string
      description: Required parameter for the relationships resource.
    - name: relationshipName
      value: string
      description: Required parameter for the relationships resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the relationships resource.
    - name: properties
      value: object
      description: |
        The definition of Relationship.

DELETE examples

delete

Deletes a relationship within a hub.

DELETE FROM azure_extras.customer_insights.relationships
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND relationshipName = '{{ relationshipName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;