Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. customerinsights
  5. Kpi
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.customerinsights.Kpi

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

The KPI resource format. Azure REST API version: 2017-04-26. Prior API version in Azure Native 1.x: 2017-04-26.

Example Usage

Kpi_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var kpi = new AzureNative.CustomerInsights.Kpi("kpi", new()
    {
        Aliases = new[]
        {
            new AzureNative.CustomerInsights.Inputs.KpiAliasArgs
            {
                AliasName = "alias",
                Expression = "Id+4",
            },
        },
        CalculationWindow = AzureNative.CustomerInsights.CalculationWindowTypes.Day,
        Description = 
        {
            { "en-us", "Kpi Description" },
        },
        DisplayName = 
        {
            { "en-us", "Kpi DisplayName" },
        },
        EntityType = AzureNative.CustomerInsights.EntityTypes.Profile,
        EntityTypeName = "testProfile2327128",
        Expression = "SavingAccountBalance",
        Function = AzureNative.CustomerInsights.KpiFunctions.Sum,
        GroupBy = new[]
        {
            "SavingAccountBalance",
        },
        HubName = "sdkTestHub",
        KpiName = "kpiTest45453647",
        ResourceGroupName = "TestHubRG",
        ThresHolds = new AzureNative.CustomerInsights.Inputs.KpiThresholdsArgs
        {
            IncreasingKpi = true,
            LowerLimit = 5,
            UpperLimit = 50,
        },
        Unit = "unit",
    });

});
Copy
package main

import (
	customerinsights "github.com/pulumi/pulumi-azure-native-sdk/customerinsights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := customerinsights.NewKpi(ctx, "kpi", &customerinsights.KpiArgs{
			Aliases: customerinsights.KpiAliasArray{
				&customerinsights.KpiAliasArgs{
					AliasName:  pulumi.String("alias"),
					Expression: pulumi.String("Id+4"),
				},
			},
			CalculationWindow: customerinsights.CalculationWindowTypesDay,
			Description: pulumi.StringMap{
				"en-us": pulumi.String("Kpi Description"),
			},
			DisplayName: pulumi.StringMap{
				"en-us": pulumi.String("Kpi DisplayName"),
			},
			EntityType:     customerinsights.EntityTypesProfile,
			EntityTypeName: pulumi.String("testProfile2327128"),
			Expression:     pulumi.String("SavingAccountBalance"),
			Function:       customerinsights.KpiFunctionsSum,
			GroupBy: pulumi.StringArray{
				pulumi.String("SavingAccountBalance"),
			},
			HubName:           pulumi.String("sdkTestHub"),
			KpiName:           pulumi.String("kpiTest45453647"),
			ResourceGroupName: pulumi.String("TestHubRG"),
			ThresHolds: &customerinsights.KpiThresholdsArgs{
				IncreasingKpi: pulumi.Bool(true),
				LowerLimit:    pulumi.Float64(5),
				UpperLimit:    pulumi.Float64(50),
			},
			Unit: pulumi.String("unit"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.customerinsights.Kpi;
import com.pulumi.azurenative.customerinsights.KpiArgs;
import com.pulumi.azurenative.customerinsights.inputs.KpiAliasArgs;
import com.pulumi.azurenative.customerinsights.inputs.KpiThresholdsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var kpi = new Kpi("kpi", KpiArgs.builder()
            .aliases(KpiAliasArgs.builder()
                .aliasName("alias")
                .expression("Id+4")
                .build())
            .calculationWindow("Day")
            .description(Map.of("en-us", "Kpi Description"))
            .displayName(Map.of("en-us", "Kpi DisplayName"))
            .entityType("Profile")
            .entityTypeName("testProfile2327128")
            .expression("SavingAccountBalance")
            .function("Sum")
            .groupBy("SavingAccountBalance")
            .hubName("sdkTestHub")
            .kpiName("kpiTest45453647")
            .resourceGroupName("TestHubRG")
            .thresHolds(KpiThresholdsArgs.builder()
                .increasingKpi(true)
                .lowerLimit(5)
                .upperLimit(50)
                .build())
            .unit("unit")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const kpi = new azure_native.customerinsights.Kpi("kpi", {
    aliases: [{
        aliasName: "alias",
        expression: "Id+4",
    }],
    calculationWindow: azure_native.customerinsights.CalculationWindowTypes.Day,
    description: {
        "en-us": "Kpi Description",
    },
    displayName: {
        "en-us": "Kpi DisplayName",
    },
    entityType: azure_native.customerinsights.EntityTypes.Profile,
    entityTypeName: "testProfile2327128",
    expression: "SavingAccountBalance",
    "function": azure_native.customerinsights.KpiFunctions.Sum,
    groupBy: ["SavingAccountBalance"],
    hubName: "sdkTestHub",
    kpiName: "kpiTest45453647",
    resourceGroupName: "TestHubRG",
    thresHolds: {
        increasingKpi: true,
        lowerLimit: 5,
        upperLimit: 50,
    },
    unit: "unit",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

kpi = azure_native.customerinsights.Kpi("kpi",
    aliases=[{
        "alias_name": "alias",
        "expression": "Id+4",
    }],
    calculation_window=azure_native.customerinsights.CalculationWindowTypes.DAY,
    description={
        "en-us": "Kpi Description",
    },
    display_name={
        "en-us": "Kpi DisplayName",
    },
    entity_type=azure_native.customerinsights.EntityTypes.PROFILE,
    entity_type_name="testProfile2327128",
    expression="SavingAccountBalance",
    function=azure_native.customerinsights.KpiFunctions.SUM,
    group_by=["SavingAccountBalance"],
    hub_name="sdkTestHub",
    kpi_name="kpiTest45453647",
    resource_group_name="TestHubRG",
    thres_holds={
        "increasing_kpi": True,
        "lower_limit": 5,
        "upper_limit": 50,
    },
    unit="unit")
Copy
resources:
  kpi:
    type: azure-native:customerinsights:Kpi
    properties:
      aliases:
        - aliasName: alias
          expression: Id+4
      calculationWindow: Day
      description:
        en-us: Kpi Description
      displayName:
        en-us: Kpi DisplayName
      entityType: Profile
      entityTypeName: testProfile2327128
      expression: SavingAccountBalance
      function: Sum
      groupBy:
        - SavingAccountBalance
      hubName: sdkTestHub
      kpiName: kpiTest45453647
      resourceGroupName: TestHubRG
      thresHolds:
        increasingKpi: true
        lowerLimit: 5
        upperLimit: 50
      unit: unit
Copy

Create Kpi Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Kpi(name: string, args: KpiArgs, opts?: CustomResourceOptions);
@overload
def Kpi(resource_name: str,
        args: KpiArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Kpi(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        expression: Optional[str] = None,
        calculation_window: Optional[CalculationWindowTypes] = None,
        resource_group_name: Optional[str] = None,
        hub_name: Optional[str] = None,
        function: Optional[KpiFunctions] = None,
        entity_type: Optional[EntityTypes] = None,
        entity_type_name: Optional[str] = None,
        display_name: Optional[Mapping[str, str]] = None,
        extracts: Optional[Sequence[KpiExtractArgs]] = None,
        filter: Optional[str] = None,
        aliases: Optional[Sequence[KpiAliasArgs]] = None,
        group_by: Optional[Sequence[str]] = None,
        description: Optional[Mapping[str, str]] = None,
        kpi_name: Optional[str] = None,
        calculation_window_field_name: Optional[str] = None,
        thres_holds: Optional[KpiThresholdsArgs] = None,
        unit: Optional[str] = None)
func NewKpi(ctx *Context, name string, args KpiArgs, opts ...ResourceOption) (*Kpi, error)
public Kpi(string name, KpiArgs args, CustomResourceOptions? opts = null)
public Kpi(String name, KpiArgs args)
public Kpi(String name, KpiArgs args, CustomResourceOptions options)

type: azure-native:customerinsights:Kpi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KpiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KpiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KpiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KpiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KpiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var kpiResource = new AzureNative.Customerinsights.Kpi("kpiResource", new()
{
    Expression = "string",
    CalculationWindow = "Lifetime",
    ResourceGroupName = "string",
    HubName = "string",
    Function = "Sum",
    EntityType = "None",
    EntityTypeName = "string",
    DisplayName = 
    {
        { "string", "string" },
    },
    Extracts = new[]
    {
        
        {
            { "expression", "string" },
            { "extractName", "string" },
        },
    },
    Filter = "string",
    Aliases = new[]
    {
        
        {
            { "aliasName", "string" },
            { "expression", "string" },
        },
    },
    GroupBy = new[]
    {
        "string",
    },
    Description = 
    {
        { "string", "string" },
    },
    KpiName = "string",
    CalculationWindowFieldName = "string",
    ThresHolds = 
    {
        { "increasingKpi", false },
        { "lowerLimit", 0 },
        { "upperLimit", 0 },
    },
    Unit = "string",
});
Copy
example, err := customerinsights.NewKpi(ctx, "kpiResource", &customerinsights.KpiArgs{
	Expression:        "string",
	CalculationWindow: "Lifetime",
	ResourceGroupName: "string",
	HubName:           "string",
	Function:          "Sum",
	EntityType:        "None",
	EntityTypeName:    "string",
	DisplayName: map[string]interface{}{
		"string": "string",
	},
	Extracts: []map[string]interface{}{
		map[string]interface{}{
			"expression":  "string",
			"extractName": "string",
		},
	},
	Filter: "string",
	Aliases: []map[string]interface{}{
		map[string]interface{}{
			"aliasName":  "string",
			"expression": "string",
		},
	},
	GroupBy: []string{
		"string",
	},
	Description: map[string]interface{}{
		"string": "string",
	},
	KpiName:                    "string",
	CalculationWindowFieldName: "string",
	ThresHolds: map[string]interface{}{
		"increasingKpi": false,
		"lowerLimit":    0,
		"upperLimit":    0,
	},
	Unit: "string",
})
Copy
var kpiResource = new Kpi("kpiResource", KpiArgs.builder()
    .expression("string")
    .calculationWindow("Lifetime")
    .resourceGroupName("string")
    .hubName("string")
    .function("Sum")
    .entityType("None")
    .entityTypeName("string")
    .displayName(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .extracts(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .filter("string")
    .aliases(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .groupBy("string")
    .description(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .kpiName("string")
    .calculationWindowFieldName("string")
    .thresHolds(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .unit("string")
    .build());
Copy
kpi_resource = azure_native.customerinsights.Kpi("kpiResource",
    expression=string,
    calculation_window=Lifetime,
    resource_group_name=string,
    hub_name=string,
    function=Sum,
    entity_type=None,
    entity_type_name=string,
    display_name={
        string: string,
    },
    extracts=[{
        expression: string,
        extractName: string,
    }],
    filter=string,
    aliases=[{
        aliasName: string,
        expression: string,
    }],
    group_by=[string],
    description={
        string: string,
    },
    kpi_name=string,
    calculation_window_field_name=string,
    thres_holds={
        increasingKpi: False,
        lowerLimit: 0,
        upperLimit: 0,
    },
    unit=string)
Copy
const kpiResource = new azure_native.customerinsights.Kpi("kpiResource", {
    expression: "string",
    calculationWindow: "Lifetime",
    resourceGroupName: "string",
    hubName: "string",
    "function": "Sum",
    entityType: "None",
    entityTypeName: "string",
    displayName: {
        string: "string",
    },
    extracts: [{
        expression: "string",
        extractName: "string",
    }],
    filter: "string",
    aliases: [{
        aliasName: "string",
        expression: "string",
    }],
    groupBy: ["string"],
    description: {
        string: "string",
    },
    kpiName: "string",
    calculationWindowFieldName: "string",
    thresHolds: {
        increasingKpi: false,
        lowerLimit: 0,
        upperLimit: 0,
    },
    unit: "string",
});
Copy
type: azure-native:customerinsights:Kpi
properties:
    aliases:
        - aliasName: string
          expression: string
    calculationWindow: Lifetime
    calculationWindowFieldName: string
    description:
        string: string
    displayName:
        string: string
    entityType: None
    entityTypeName: string
    expression: string
    extracts:
        - expression: string
          extractName: string
    filter: string
    function: Sum
    groupBy:
        - string
    hubName: string
    kpiName: string
    resourceGroupName: string
    thresHolds:
        increasingKpi: false
        lowerLimit: 0
        upperLimit: 0
    unit: string
Copy

Kpi Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Kpi resource accepts the following input properties:

CalculationWindow This property is required. Pulumi.AzureNative.CustomerInsights.CalculationWindowTypes
The calculation window.
EntityType This property is required. Pulumi.AzureNative.CustomerInsights.EntityTypes
The mapping entity type.
EntityTypeName This property is required. string
The mapping entity name.
Expression This property is required. string
The computation expression for the KPI.
Function This property is required. Pulumi.AzureNative.CustomerInsights.KpiFunctions
The computation function for the KPI.
HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Aliases List<Pulumi.AzureNative.CustomerInsights.Inputs.KpiAlias>
The aliases.
CalculationWindowFieldName string
Name of calculation window field.
Description Dictionary<string, string>
Localized description for the KPI.
DisplayName Dictionary<string, string>
Localized display name for the KPI.
Extracts List<Pulumi.AzureNative.CustomerInsights.Inputs.KpiExtract>
The KPI extracts.
Filter string
The filter expression for the KPI.
GroupBy List<string>
the group by properties for the KPI.
KpiName Changes to this property will trigger replacement. string
The name of the KPI.
ThresHolds Pulumi.AzureNative.CustomerInsights.Inputs.KpiThresholds
The KPI thresholds.
Unit string
The unit of measurement for the KPI.
CalculationWindow This property is required. CalculationWindowTypes
The calculation window.
EntityType This property is required. EntityTypes
The mapping entity type.
EntityTypeName This property is required. string
The mapping entity name.
Expression This property is required. string
The computation expression for the KPI.
Function This property is required. KpiFunctions
The computation function for the KPI.
HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Aliases []KpiAliasArgs
The aliases.
CalculationWindowFieldName string
Name of calculation window field.
Description map[string]string
Localized description for the KPI.
DisplayName map[string]string
Localized display name for the KPI.
Extracts []KpiExtractArgs
The KPI extracts.
Filter string
The filter expression for the KPI.
GroupBy []string
the group by properties for the KPI.
KpiName Changes to this property will trigger replacement. string
The name of the KPI.
ThresHolds KpiThresholdsArgs
The KPI thresholds.
Unit string
The unit of measurement for the KPI.
calculationWindow This property is required. CalculationWindowTypes
The calculation window.
entityType This property is required. EntityTypes
The mapping entity type.
entityTypeName This property is required. String
The mapping entity name.
expression This property is required. String
The computation expression for the KPI.
function This property is required. KpiFunctions
The computation function for the KPI.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
aliases List<KpiAlias>
The aliases.
calculationWindowFieldName String
Name of calculation window field.
description Map<String,String>
Localized description for the KPI.
displayName Map<String,String>
Localized display name for the KPI.
extracts List<KpiExtract>
The KPI extracts.
filter String
The filter expression for the KPI.
groupBy List<String>
the group by properties for the KPI.
kpiName Changes to this property will trigger replacement. String
The name of the KPI.
thresHolds KpiThresholds
The KPI thresholds.
unit String
The unit of measurement for the KPI.
calculationWindow This property is required. CalculationWindowTypes
The calculation window.
entityType This property is required. EntityTypes
The mapping entity type.
entityTypeName This property is required. string
The mapping entity name.
expression This property is required. string
The computation expression for the KPI.
function This property is required. KpiFunctions
The computation function for the KPI.
hubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
aliases KpiAlias[]
The aliases.
calculationWindowFieldName string
Name of calculation window field.
description {[key: string]: string}
Localized description for the KPI.
displayName {[key: string]: string}
Localized display name for the KPI.
extracts KpiExtract[]
The KPI extracts.
filter string
The filter expression for the KPI.
groupBy string[]
the group by properties for the KPI.
kpiName Changes to this property will trigger replacement. string
The name of the KPI.
thresHolds KpiThresholds
The KPI thresholds.
unit string
The unit of measurement for the KPI.
calculation_window This property is required. CalculationWindowTypes
The calculation window.
entity_type This property is required. EntityTypes
The mapping entity type.
entity_type_name This property is required. str
The mapping entity name.
expression This property is required. str
The computation expression for the KPI.
function This property is required. KpiFunctions
The computation function for the KPI.
hub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the hub.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
aliases Sequence[KpiAliasArgs]
The aliases.
calculation_window_field_name str
Name of calculation window field.
description Mapping[str, str]
Localized description for the KPI.
display_name Mapping[str, str]
Localized display name for the KPI.
extracts Sequence[KpiExtractArgs]
The KPI extracts.
filter str
The filter expression for the KPI.
group_by Sequence[str]
the group by properties for the KPI.
kpi_name Changes to this property will trigger replacement. str
The name of the KPI.
thres_holds KpiThresholdsArgs
The KPI thresholds.
unit str
The unit of measurement for the KPI.
calculationWindow This property is required. "Lifetime" | "Hour" | "Day" | "Week" | "Month"
The calculation window.
entityType This property is required. "None" | "Profile" | "Interaction" | "Relationship"
The mapping entity type.
entityTypeName This property is required. String
The mapping entity name.
expression This property is required. String
The computation expression for the KPI.
function This property is required. "Sum" | "Avg" | "Min" | "Max" | "Last" | "Count" | "None" | "CountDistinct"
The computation function for the KPI.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
aliases List<Property Map>
The aliases.
calculationWindowFieldName String
Name of calculation window field.
description Map<String>
Localized description for the KPI.
displayName Map<String>
Localized display name for the KPI.
extracts List<Property Map>
The KPI extracts.
filter String
The filter expression for the KPI.
groupBy List<String>
the group by properties for the KPI.
kpiName Changes to this property will trigger replacement. String
The name of the KPI.
thresHolds Property Map
The KPI thresholds.
unit String
The unit of measurement for the KPI.

Outputs

All input properties are implicitly available as output properties. Additionally, the Kpi resource produces the following output properties:

GroupByMetadata List<Pulumi.AzureNative.CustomerInsights.Outputs.KpiGroupByMetadataResponse>
The KPI GroupByMetadata.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ParticipantProfilesMetadata List<Pulumi.AzureNative.CustomerInsights.Outputs.KpiParticipantProfilesMetadataResponse>
The participant profiles.
ProvisioningState string
Provisioning state.
TenantId string
The hub name.
Type string
Resource type.
GroupByMetadata []KpiGroupByMetadataResponse
The KPI GroupByMetadata.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ParticipantProfilesMetadata []KpiParticipantProfilesMetadataResponse
The participant profiles.
ProvisioningState string
Provisioning state.
TenantId string
The hub name.
Type string
Resource type.
groupByMetadata List<KpiGroupByMetadataResponse>
The KPI GroupByMetadata.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
participantProfilesMetadata List<KpiParticipantProfilesMetadataResponse>
The participant profiles.
provisioningState String
Provisioning state.
tenantId String
The hub name.
type String
Resource type.
groupByMetadata KpiGroupByMetadataResponse[]
The KPI GroupByMetadata.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
participantProfilesMetadata KpiParticipantProfilesMetadataResponse[]
The participant profiles.
provisioningState string
Provisioning state.
tenantId string
The hub name.
type string
Resource type.
group_by_metadata Sequence[KpiGroupByMetadataResponse]
The KPI GroupByMetadata.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
participant_profiles_metadata Sequence[KpiParticipantProfilesMetadataResponse]
The participant profiles.
provisioning_state str
Provisioning state.
tenant_id str
The hub name.
type str
Resource type.
groupByMetadata List<Property Map>
The KPI GroupByMetadata.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
participantProfilesMetadata List<Property Map>
The participant profiles.
provisioningState String
Provisioning state.
tenantId String
The hub name.
type String
Resource type.

Supporting Types

CalculationWindowTypes
, CalculationWindowTypesArgs

Lifetime
Lifetime
Hour
Hour
Day
Day
Week
Week
Month
Month
CalculationWindowTypesLifetime
Lifetime
CalculationWindowTypesHour
Hour
CalculationWindowTypesDay
Day
CalculationWindowTypesWeek
Week
CalculationWindowTypesMonth
Month
Lifetime
Lifetime
Hour
Hour
Day
Day
Week
Week
Month
Month
Lifetime
Lifetime
Hour
Hour
Day
Day
Week
Week
Month
Month
LIFETIME
Lifetime
HOUR
Hour
DAY
Day
WEEK
Week
MONTH
Month
"Lifetime"
Lifetime
"Hour"
Hour
"Day"
Day
"Week"
Week
"Month"
Month

EntityTypes
, EntityTypesArgs

None
None
Profile
Profile
Interaction
Interaction
Relationship
Relationship
EntityTypesNone
None
EntityTypesProfile
Profile
EntityTypesInteraction
Interaction
EntityTypesRelationship
Relationship
None
None
Profile
Profile
Interaction
Interaction
Relationship
Relationship
None
None
Profile
Profile
Interaction
Interaction
Relationship
Relationship
NONE
None
PROFILE
Profile
INTERACTION
Interaction
RELATIONSHIP
Relationship
"None"
None
"Profile"
Profile
"Interaction"
Interaction
"Relationship"
Relationship

KpiAlias
, KpiAliasArgs

AliasName This property is required. string
KPI alias name.
Expression This property is required. string
The expression.
AliasName This property is required. string
KPI alias name.
Expression This property is required. string
The expression.
aliasName This property is required. String
KPI alias name.
expression This property is required. String
The expression.
aliasName This property is required. string
KPI alias name.
expression This property is required. string
The expression.
alias_name This property is required. str
KPI alias name.
expression This property is required. str
The expression.
aliasName This property is required. String
KPI alias name.
expression This property is required. String
The expression.

KpiAliasResponse
, KpiAliasResponseArgs

AliasName This property is required. string
KPI alias name.
Expression This property is required. string
The expression.
AliasName This property is required. string
KPI alias name.
Expression This property is required. string
The expression.
aliasName This property is required. String
KPI alias name.
expression This property is required. String
The expression.
aliasName This property is required. string
KPI alias name.
expression This property is required. string
The expression.
alias_name This property is required. str
KPI alias name.
expression This property is required. str
The expression.
aliasName This property is required. String
KPI alias name.
expression This property is required. String
The expression.

KpiExtract
, KpiExtractArgs

Expression This property is required. string
The expression.
ExtractName This property is required. string
KPI extract name.
Expression This property is required. string
The expression.
ExtractName This property is required. string
KPI extract name.
expression This property is required. String
The expression.
extractName This property is required. String
KPI extract name.
expression This property is required. string
The expression.
extractName This property is required. string
KPI extract name.
expression This property is required. str
The expression.
extract_name This property is required. str
KPI extract name.
expression This property is required. String
The expression.
extractName This property is required. String
KPI extract name.

KpiExtractResponse
, KpiExtractResponseArgs

Expression This property is required. string
The expression.
ExtractName This property is required. string
KPI extract name.
Expression This property is required. string
The expression.
ExtractName This property is required. string
KPI extract name.
expression This property is required. String
The expression.
extractName This property is required. String
KPI extract name.
expression This property is required. string
The expression.
extractName This property is required. string
KPI extract name.
expression This property is required. str
The expression.
extract_name This property is required. str
KPI extract name.
expression This property is required. String
The expression.
extractName This property is required. String
KPI extract name.

KpiFunctions
, KpiFunctionsArgs

Sum
Sum
Avg
Avg
Min
Min
Max
Max
Last
Last
Count
Count
None
None
CountDistinct
CountDistinct
KpiFunctionsSum
Sum
KpiFunctionsAvg
Avg
KpiFunctionsMin
Min
KpiFunctionsMax
Max
KpiFunctionsLast
Last
KpiFunctionsCount
Count
KpiFunctionsNone
None
KpiFunctionsCountDistinct
CountDistinct
Sum
Sum
Avg
Avg
Min
Min
Max
Max
Last
Last
Count
Count
None
None
CountDistinct
CountDistinct
Sum
Sum
Avg
Avg
Min
Min
Max
Max
Last
Last
Count
Count
None
None
CountDistinct
CountDistinct
SUM
Sum
AVG
Avg
MIN
Min
MAX
Max
LAST
Last
COUNT
Count
NONE
None
COUNT_DISTINCT
CountDistinct
"Sum"
Sum
"Avg"
Avg
"Min"
Min
"Max"
Max
"Last"
Last
"Count"
Count
"None"
None
"CountDistinct"
CountDistinct

KpiGroupByMetadataResponse
, KpiGroupByMetadataResponseArgs

DisplayName Dictionary<string, string>
The display name.
FieldName string
The name of the field.
FieldType string
The type of the field.
DisplayName map[string]string
The display name.
FieldName string
The name of the field.
FieldType string
The type of the field.
displayName Map<String,String>
The display name.
fieldName String
The name of the field.
fieldType String
The type of the field.
displayName {[key: string]: string}
The display name.
fieldName string
The name of the field.
fieldType string
The type of the field.
display_name Mapping[str, str]
The display name.
field_name str
The name of the field.
field_type str
The type of the field.
displayName Map<String>
The display name.
fieldName String
The name of the field.
fieldType String
The type of the field.

KpiParticipantProfilesMetadataResponse
, KpiParticipantProfilesMetadataResponseArgs

TypeName This property is required. string
Name of the type.
TypeName This property is required. string
Name of the type.
typeName This property is required. String
Name of the type.
typeName This property is required. string
Name of the type.
type_name This property is required. str
Name of the type.
typeName This property is required. String
Name of the type.

KpiThresholds
, KpiThresholdsArgs

IncreasingKpi This property is required. bool
Whether or not the KPI is an increasing KPI.
LowerLimit This property is required. double
The lower threshold limit.
UpperLimit This property is required. double
The upper threshold limit.
IncreasingKpi This property is required. bool
Whether or not the KPI is an increasing KPI.
LowerLimit This property is required. float64
The lower threshold limit.
UpperLimit This property is required. float64
The upper threshold limit.
increasingKpi This property is required. Boolean
Whether or not the KPI is an increasing KPI.
lowerLimit This property is required. Double
The lower threshold limit.
upperLimit This property is required. Double
The upper threshold limit.
increasingKpi This property is required. boolean
Whether or not the KPI is an increasing KPI.
lowerLimit This property is required. number
The lower threshold limit.
upperLimit This property is required. number
The upper threshold limit.
increasing_kpi This property is required. bool
Whether or not the KPI is an increasing KPI.
lower_limit This property is required. float
The lower threshold limit.
upper_limit This property is required. float
The upper threshold limit.
increasingKpi This property is required. Boolean
Whether or not the KPI is an increasing KPI.
lowerLimit This property is required. Number
The lower threshold limit.
upperLimit This property is required. Number
The upper threshold limit.

KpiThresholdsResponse
, KpiThresholdsResponseArgs

IncreasingKpi This property is required. bool
Whether or not the KPI is an increasing KPI.
LowerLimit This property is required. double
The lower threshold limit.
UpperLimit This property is required. double
The upper threshold limit.
IncreasingKpi This property is required. bool
Whether or not the KPI is an increasing KPI.
LowerLimit This property is required. float64
The lower threshold limit.
UpperLimit This property is required. float64
The upper threshold limit.
increasingKpi This property is required. Boolean
Whether or not the KPI is an increasing KPI.
lowerLimit This property is required. Double
The lower threshold limit.
upperLimit This property is required. Double
The upper threshold limit.
increasingKpi This property is required. boolean
Whether or not the KPI is an increasing KPI.
lowerLimit This property is required. number
The lower threshold limit.
upperLimit This property is required. number
The upper threshold limit.
increasing_kpi This property is required. bool
Whether or not the KPI is an increasing KPI.
lower_limit This property is required. float
The lower threshold limit.
upper_limit This property is required. float
The upper threshold limit.
increasingKpi This property is required. Boolean
Whether or not the KPI is an increasing KPI.
lowerLimit This property is required. Number
The lower threshold limit.
upperLimit This property is required. Number
The upper threshold limit.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:customerinsights:Kpi sdkTestHub/kpiTest45453647 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native