KpiResourceFormat interface

Package:

@azure/arm-customerinsights

The KPI resource format.

Extends

ProxyResource

Properties

aliases	The aliases.
calculationWindow	The calculation window.
calculationWindowFieldName	Name of calculation window field.
description	Localized description for the KPI.
displayName	Localized display name for the KPI.
entityType	The mapping entity type.
entityTypeName	The mapping entity name.
expression	The computation expression for the KPI.
extracts	The KPI extracts.
filter	The filter expression for the KPI.
function	The computation function for the KPI.
groupBy	the group by properties for the KPI.
groupByMetadata	The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.
kpiName	The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.
participantProfilesMetadata	The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId	The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
thresHolds	The KPI thresholds.
unit	The unit of measurement for the KPI.

Inherited Properties

id	Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

aliases

The aliases.

aliases?: KpiAlias[]

Property Value

KpiAlias[]

calculationWindow

The calculation window.

calculationWindow?: CalculationWindowTypes

Property Value

CalculationWindowTypes

calculationWindowFieldName

Name of calculation window field.

calculationWindowFieldName?: string

Property Value

string

description

Localized description for the KPI.

description?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

displayName

Localized display name for the KPI.

displayName?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

entityType

The mapping entity type.

entityType?: EntityTypes

Property Value

EntityTypes

entityTypeName

The mapping entity name.

entityTypeName?: string

Property Value

string

expression

The computation expression for the KPI.

expression?: string

Property Value

string

extracts

The KPI extracts.

extracts?: KpiExtract[]

Property Value

KpiExtract[]

filter

The filter expression for the KPI.

filter?: string

Property Value

string

function

The computation function for the KPI.

function?: KpiFunctions

Property Value

KpiFunctions

groupBy

the group by properties for the KPI.

groupBy?: string[]

Property Value

string[]

groupByMetadata

The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.

groupByMetadata?: KpiGroupByMetadata[]

Property Value

KpiGroupByMetadata[]

kpiName

The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.

kpiName?: string

Property Value

string

participantProfilesMetadata

The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.

participantProfilesMetadata?: KpiParticipantProfilesMetadata[]

Property Value

KpiParticipantProfilesMetadata[]

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

thresHolds

The KPI thresholds.

thresHolds?: KpiThresholds

Property Value

KpiThresholds

unit

The unit of measurement for the KPI.

unit?: string

Property Value

string

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type