kpis

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

Overview

Name	kpis
Type	Resource
Id	azure_extras.customer_insights.kpis

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the KPI.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Defines the KPI Threshold limits.
type	string	Resource type.

list_by_hub

OK. Successfully get all the KPIs in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Defines the KPI Threshold limits.
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, kpiName, subscriptionId		Gets a KPI in the hub.
list_by_hub	select	resourceGroupName, hubName, subscriptionId		Gets all the KPIs in the specified hub.
create_or_update	insert	resourceGroupName, hubName, kpiName, subscriptionId		Creates a KPI or updates an existing KPI in the hub.
delete	delete	resourceGroupName, hubName, kpiName, subscriptionId		Deletes a KPI in the hub.
reprocess	exec	resourceGroupName, hubName, kpiName, subscriptionId		Reprocesses the Kpi values of the specified KPI.

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.
kpiName	string	The name of the KPI.
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 KPI in the hub.

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

list_by_hub

Gets all the KPIs in the specified hub.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: kpis
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the kpis resource.
    - name: hubName
      value: string
      description: Required parameter for the kpis resource.
    - name: kpiName
      value: string
      description: Required parameter for the kpis resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the kpis resource.
    - name: properties
      value: object
      description: |
        Defines the KPI Threshold limits.

DELETE examples

delete

Deletes a KPI in the hub.

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

Lifecycle Methods

reprocess

Reprocesses the Kpi values of the specified KPI.

EXEC azure_extras.customer_insights.kpis.reprocess 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hubName='{{ hubName }}' --required, 
@kpiName='{{ kpiName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;