kpis

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

Overview

Name	kpis
Type	Resource
Id	azure_extras.customer_insights.kpis

Fields

vw_kpis

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
description	text	field from the properties object
aliases	text	field from the properties object
calculation_window	text	field from the properties object
calculation_window_field_name	text	field from the properties object
display_name	text	field from the properties object
entity_type	text	field from the properties object
entity_type_name	text	field from the properties object
expression	text	field from the properties object
extracts	text	field from the properties object
filter	text	field from the properties object
function	text	field from the properties object
group_by	text	field from the properties object
group_by_metadata	text	field from the properties object
hubName	text	field from the properties object
kpiName	text	field from the properties object
kpi_name	text	field from the properties object
participant_profiles_metadata	text	field from the properties object
provisioning_state	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
thres_holds	text	field from the properties object
type	text	Resource type.
unit	text	field from the properties object

kpis

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hubName, kpiName, resourceGroupName, subscriptionId	Gets a KPI in the hub.
list_by_hub	SELECT	hubName, resourceGroupName, subscriptionId	Gets all the KPIs in the specified hub.
create_or_update	INSERT	hubName, kpiName, resourceGroupName, subscriptionId	Creates a KPI or updates an existing KPI in the hub.
delete	DELETE	hubName, kpiName, resourceGroupName, subscriptionId	Deletes a KPI in the hub.
reprocess	EXEC	hubName, kpiName, resourceGroupName, subscriptionId	Reprocesses the Kpi values of the specified KPI.

SELECT examples

Gets all the KPIs in the specified hub.

vw_kpis

SELECT
id,
name,
description,
aliases,
calculation_window,
calculation_window_field_name,
display_name,
entity_type,
entity_type_name,
expression,
extracts,
filter,
function,
group_by,
group_by_metadata,
hubName,
kpiName,
kpi_name,
participant_profiles_metadata,
provisioning_state,
resourceGroupName,
subscriptionId,
tenant_id,
thres_holds,
type,
unit
FROM azure_extras.customer_insights.vw_kpis
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

kpis

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: entityType
          value: string
        - name: entityTypeName
          value: string
        - name: tenantId
          value: string
        - name: kpiName
          value: string
        - name: displayName
          value: object
        - name: description
          value: object
        - name: calculationWindow
          value: string
        - name: calculationWindowFieldName
          value: string
        - name: function
          value: string
        - name: expression
          value: string
        - name: unit
          value: string
        - name: filter
          value: string
        - name: groupBy
          value:
            - string
        - name: groupByMetadata
          value:
            - - name: displayName
                value: object
              - name: fieldName
                value: string
              - name: fieldType
                value: string
        - name: participantProfilesMetadata
          value:
            - - name: typeName
                value: string
        - name: provisioningState
          value: []
        - name: thresHolds
          value:
            - name: lowerLimit
              value: number
            - name: upperLimit
              value: number
            - name: increasingKpi
              value: boolean
        - name: aliases
          value:
            - - name: aliasName
                value: string
              - name: expression
                value: string
        - name: extracts
          value:
            - - name: extractName
                value: string
              - name: expression
                value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

DELETE example

Deletes the specified kpis resource.

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