Microsoft.CustomerInsights hubs/kpi 2017-01-01

The hubs/kpi resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.CustomerInsights/hubs/kpi resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.CustomerInsights/hubs/kpi@2017-01-01' = {
  name: 'string'
  properties: {
    aliases: [
      {
        aliasName: 'string'
        expression: 'string'
      }
    ]
    calculationWindow: 'string'
    calculationWindowFieldName: 'string'
    description: {}
    displayName: {}
    entityType: 'string'
    entityTypeName: 'string'
    expression: 'string'
    extracts: [
      {
        expression: 'string'
        extractName: 'string'
      }
    ]
    filter: 'string'
    function: 'string'
    groupBy: [ 'string' ]
    thresHolds: {
      increasingKpi: bool
      lowerLimit: int
      upperLimit: int
    }
    unit: 'string'
  }
}

Property values

hubs/kpi

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.CustomerInsights/hubs/kpi'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-01-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Defines the KPI Threshold limits. KpiDefinition

KpiDefinition

Name Description Value
aliases The aliases. KpiAlias[]
calculationWindow The calculation window. 'Day'
'Hour'
'Lifetime'
'Month'
'Week'
calculationWindowFieldName Name of calculation window field. string
description Localized description for the KPI. object
displayName Localized display name for the KPI. object
entityType Type of entity. 'Interaction'
'None'
'Profile'
'Relationship'
entityTypeName The mapping entity name. string (required)
expression The computation expression for the KPI. string (required)
extracts The KPI extracts. KpiExtract[]
filter The filter expression for the KPI. string
function The computation function for the KPI. 'Avg'
'Count'
'CountDistinct'
'Last'
'Max'
'Min'
'None'
'Sum'
groupBy the group by properties for the KPI. string[]
thresHolds Defines the KPI Threshold limits. KpiThresholds
unit The unit of measurement for the KPI. string

KpiAlias

Name Description Value
aliasName KPI alias name. string (required)
expression The expression. string (required)

KpiExtract

Name Description Value
expression The expression. string (required)
extractName KPI extract name. string (required)

KpiThresholds

Name Description Value
increasingKpi Whether or not the KPI is an increasing KPI. bool (required)
lowerLimit The lower threshold limit. int (required)
upperLimit The upper threshold limit. int (required)