hubs

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

Overview

Name	hubs
Type	Resource
Id	azure_extras.customer_insights.hubs

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
location	string	Resource location.
properties	object	Properties of hub.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

OK. Successfully get all the hubs in the resource group.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
location	string	Resource location.
properties	object	Properties of hub.
tags	object	Resource tags.
type	string	Resource type.

list

OK. Successfully get all the hubs in the subscription.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
location	string	Resource location.
properties	object	Properties of hub.
tags	object	Resource tags.
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, subscriptionId		Gets information about the specified hub.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the hubs in a resource group.
list	select	subscriptionId		Gets all hubs in the specified subscription.
create_or_update	insert	resourceGroupName, hubName, subscriptionId		Creates a hub, or updates an existing hub.
update	update	resourceGroupName, hubName, subscriptionId		Updates a Hub.
delete	delete	resourceGroupName, hubName, subscriptionId		Deletes the specified 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.
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 hub.

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

list_by_resource_group

Gets all the hubs in a resource group.

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

list

Gets all hubs in the specified subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_extras.customer_insights.hubs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a hub, or updates an existing hub.

INSERT INTO azure_extras.customer_insights.hubs (
data__properties,
data__location,
data__tags,
resourceGroupName,
hubName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ hubName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: hubs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the hubs resource.
    - name: hubName
      value: string
      description: Required parameter for the hubs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the hubs resource.
    - name: properties
      value: object
      description: |
        Properties of hub.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

Updates a Hub.

UPDATE azure_extras.customer_insights.hubs
SET 
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified hub.

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