links

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

Overview

Name	links
Type	Resource
Id	azure_extras.customer_insights.links

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the link.

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

list_by_hub

OK. Successfully get all the links in the hub.

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

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

list_by_hub

Gets all the links in the specified hub.

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

INSERT examples

create_or_update

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

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

Manifest

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

DELETE examples

delete

Deletes a link in the hub.

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