1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. customerinsights
  6. Kpi
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.32.0
published on Wednesday, Nov 18, 2026 by Pulumi
azure-native logo Azure Native
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.32.0
published on Wednesday, Nov 18, 2026 by Pulumi

    The KPI resource format.

    Uses Azure REST API version 2017-04-26. In version 2.x of the Azure Native provider, it used API version 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.0,
                UpperLimit = 50.0,
            },
            Unit = "unit",
        });
    
    });
    
    package main
    
    import (
    	customerinsights "github.com/pulumi/pulumi-azure-native-sdk/customerinsights/v3"
    	"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
    	})
    }
    
    terraform {
      required_providers {
        azure-native = {
          source = "pulumi/azure-native"
        }
      }
    }
    
    resource "azure-native_customerinsights_kpi" "kpi" {
      lifecycle {
        create_before_destroy = true
      }
      aliases {
        alias_name = "alias"
        expression = "Id+4"
      }
      calculation_window = "Day"
      description = {
        "en-us" = "Kpi Description"
      }
      display_name = {
        "en-us" = "Kpi DisplayName"
      }
      entity_type         = "Profile"
      entity_type_name    = "testProfile2327128"
      expression          = "SavingAccountBalance"
      function            = "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"
    }
    
    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.ArrayList;
    import java.util.Arrays;
    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.0)
                    .upperLimit(50.0)
                    .build())
                .unit("unit")
                .build());
    
        }
    }
    
    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",
    });
    
    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": float(5),
            "upper_limit": float(50),
        },
        unit="unit")
    
    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
    

    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.
    
    
    resource "azure-native_customerinsights_kpi" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args KpiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args KpiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KpiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 = AzureNative.CustomerInsights.CalculationWindowTypes.Lifetime,
        ResourceGroupName = "string",
        HubName = "string",
        Function = AzureNative.CustomerInsights.KpiFunctions.Sum,
        EntityType = AzureNative.CustomerInsights.EntityTypes.None,
        EntityTypeName = "string",
        DisplayName = 
        {
            { "string", "string" },
        },
        Extracts = new[]
        {
            new AzureNative.CustomerInsights.Inputs.KpiExtractArgs
            {
                Expression = "string",
                ExtractName = "string",
            },
        },
        Filter = "string",
        Aliases = new[]
        {
            new AzureNative.CustomerInsights.Inputs.KpiAliasArgs
            {
                AliasName = "string",
                Expression = "string",
            },
        },
        GroupBy = new[]
        {
            "string",
        },
        Description = 
        {
            { "string", "string" },
        },
        KpiName = "string",
        CalculationWindowFieldName = "string",
        ThresHolds = new AzureNative.CustomerInsights.Inputs.KpiThresholdsArgs
        {
            IncreasingKpi = false,
            LowerLimit = 0.0,
            UpperLimit = 0.0,
        },
        Unit = "string",
    });
    
    example, err := customerinsights.NewKpi(ctx, "kpiResource", &customerinsights.KpiArgs{
    	Expression:        pulumi.String("string"),
    	CalculationWindow: customerinsights.CalculationWindowTypesLifetime,
    	ResourceGroupName: pulumi.String("string"),
    	HubName:           pulumi.String("string"),
    	Function:          customerinsights.KpiFunctionsSum,
    	EntityType:        customerinsights.EntityTypesNone,
    	EntityTypeName:    pulumi.String("string"),
    	DisplayName: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Extracts: customerinsights.KpiExtractArray{
    		&customerinsights.KpiExtractArgs{
    			Expression:  pulumi.String("string"),
    			ExtractName: pulumi.String("string"),
    		},
    	},
    	Filter: pulumi.String("string"),
    	Aliases: customerinsights.KpiAliasArray{
    		&customerinsights.KpiAliasArgs{
    			AliasName:  pulumi.String("string"),
    			Expression: pulumi.String("string"),
    		},
    	},
    	GroupBy: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	KpiName:                    pulumi.String("string"),
    	CalculationWindowFieldName: pulumi.String("string"),
    	ThresHolds: &customerinsights.KpiThresholdsArgs{
    		IncreasingKpi: pulumi.Bool(false),
    		LowerLimit:    pulumi.Float64(0),
    		UpperLimit:    pulumi.Float64(0),
    	},
    	Unit: pulumi.String("string"),
    })
    
    resource "azure-native_customerinsights_kpi" "kpiResource" {
      lifecycle {
        create_before_destroy = true
      }
      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"
        extract_name = "string"
      }
      filter = "string"
      aliases {
        alias_name = "string"
        expression = "string"
      }
      group_by = ["string"]
      description = {
        "string" = "string"
      }
      kpi_name                      = "string"
      calculation_window_field_name = "string"
      thres_holds = {
        increasing_kpi = false
        lower_limit    = 0
        upper_limit    = 0
      }
      unit = "string"
    }
    
    var kpiResource = new Kpi("kpiResource", KpiArgs.builder()
        .expression("string")
        .calculationWindow(com.pulumi.azurenative.customerinsights.enums.CalculationWindowTypes.Lifetime)
        .resourceGroupName("string")
        .hubName("string")
        .function(com.pulumi.azurenative.customerinsights.enums.KpiFunctions.Sum)
        .entityType(com.pulumi.azurenative.customerinsights.enums.EntityTypes.None)
        .entityTypeName("string")
        .displayName(Map.of("string", "string"))
        .extracts(KpiExtractArgs.builder()
            .expression("string")
            .extractName("string")
            .build())
        .filter("string")
        .aliases(KpiAliasArgs.builder()
            .aliasName("string")
            .expression("string")
            .build())
        .groupBy("string")
        .description(Map.of("string", "string"))
        .kpiName("string")
        .calculationWindowFieldName("string")
        .thresHolds(KpiThresholdsArgs.builder()
            .increasingKpi(false)
            .lowerLimit(0.0)
            .upperLimit(0.0)
            .build())
        .unit("string")
        .build());
    
    kpi_resource = azure_native.customerinsights.Kpi("kpiResource",
        expression="string",
        calculation_window=azure_native.customerinsights.CalculationWindowTypes.LIFETIME,
        resource_group_name="string",
        hub_name="string",
        function=azure_native.customerinsights.KpiFunctions.SUM,
        entity_type=azure_native.customerinsights.EntityTypes.NONE,
        entity_type_name="string",
        display_name={
            "string": "string",
        },
        extracts=[{
            "expression": "string",
            "extract_name": "string",
        }],
        filter="string",
        aliases=[{
            "alias_name": "string",
            "expression": "string",
        }],
        group_by=["string"],
        description={
            "string": "string",
        },
        kpi_name="string",
        calculation_window_field_name="string",
        thres_holds={
            "increasing_kpi": False,
            "lower_limit": float(0),
            "upper_limit": float(0),
        },
        unit="string")
    
    const kpiResource = new azure_native.customerinsights.Kpi("kpiResource", {
        expression: "string",
        calculationWindow: azure_native.customerinsights.CalculationWindowTypes.Lifetime,
        resourceGroupName: "string",
        hubName: "string",
        "function": azure_native.customerinsights.KpiFunctions.Sum,
        entityType: azure_native.customerinsights.EntityTypes.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",
    });
    
    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
    

    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 Pulumi.AzureNative.CustomerInsights.CalculationWindowTypes
    The calculation window.
    EntityType Pulumi.AzureNative.CustomerInsights.EntityTypes
    The mapping entity type.
    EntityTypeName string
    The mapping entity name.
    Expression string
    The computation expression for the KPI.
    Function Pulumi.AzureNative.CustomerInsights.KpiFunctions
    The computation function for the KPI.
    HubName string
    The name of the hub.
    ResourceGroupName 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 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 CalculationWindowTypes
    The calculation window.
    EntityType EntityTypes
    The mapping entity type.
    EntityTypeName string
    The mapping entity name.
    Expression string
    The computation expression for the KPI.
    Function KpiFunctions
    The computation function for the KPI.
    HubName string
    The name of the hub.
    ResourceGroupName 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 string
    The name of the KPI.
    ThresHolds KpiThresholdsArgs
    The KPI thresholds.
    Unit string
    The unit of measurement for the KPI.
    calculation_window "Lifetime" | "Hour" | "Day" | "Week" | "Month"
    The calculation window.
    entity_type "None" | "Profile" | "Interaction" | "Relationship"
    The mapping entity type.
    entity_type_name string
    The mapping entity name.
    expression string
    The computation expression for the KPI.
    function "Sum" | "Avg" | "Min" | "Max" | "Last" | "Count" | "None" | "CountDistinct"
    The computation function for the KPI.
    hub_name string
    The name of the hub.
    resource_group_name string
    The name of the resource group.
    aliases list(object)
    The aliases.
    calculation_window_field_name string
    Name of calculation window field.
    description map(string)
    Localized description for the KPI.
    display_name map(string)
    Localized display name for the KPI.
    extracts list(object)
    The KPI extracts.
    filter string
    The filter expression for the KPI.
    group_by list(string)
    the group by properties for the KPI.
    kpi_name string
    The name of the KPI.
    thres_holds object
    The KPI thresholds.
    unit string
    The unit of measurement for the KPI.
    calculationWindow CalculationWindowTypes
    The calculation window.
    entityType EntityTypes
    The mapping entity type.
    entityTypeName String
    The mapping entity name.
    expression String
    The computation expression for the KPI.
    function KpiFunctions
    The computation function for the KPI.
    hubName String
    The name of the hub.
    resourceGroupName 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 String
    The name of the KPI.
    thresHolds KpiThresholds
    The KPI thresholds.
    unit String
    The unit of measurement for the KPI.
    calculationWindow CalculationWindowTypes
    The calculation window.
    entityType EntityTypes
    The mapping entity type.
    entityTypeName string
    The mapping entity name.
    expression string
    The computation expression for the KPI.
    function KpiFunctions
    The computation function for the KPI.
    hubName string
    The name of the hub.
    resourceGroupName 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 string
    The name of the KPI.
    thresHolds KpiThresholds
    The KPI thresholds.
    unit string
    The unit of measurement for the KPI.
    calculation_window CalculationWindowTypes
    The calculation window.
    entity_type EntityTypes
    The mapping entity type.
    entity_type_name str
    The mapping entity name.
    expression str
    The computation expression for the KPI.
    function KpiFunctions
    The computation function for the KPI.
    hub_name str
    The name of the hub.
    resource_group_name 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 str
    The name of the KPI.
    thres_holds KpiThresholdsArgs
    The KPI thresholds.
    unit str
    The unit of measurement for the KPI.
    calculationWindow "Lifetime" | "Hour" | "Day" | "Week" | "Month"
    The calculation window.
    entityType "None" | "Profile" | "Interaction" | "Relationship"
    The mapping entity type.
    entityTypeName String
    The mapping entity name.
    expression String
    The computation expression for the KPI.
    function "Sum" | "Avg" | "Min" | "Max" | "Last" | "Count" | "None" | "CountDistinct"
    The computation function for the KPI.
    hubName String
    The name of the hub.
    resourceGroupName 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 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:

    AzureApiVersion string
    The Azure API version of the resource.
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    azure_api_version string
    The Azure API version of the resource.
    group_by_metadata list(object)
    The KPI GroupByMetadata.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    participant_profiles_metadata list(object)
    The participant profiles.
    provisioning_state string
    Provisioning state.
    tenant_id string
    The hub name.
    type string
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    azureApiVersion string
    The Azure API version of the resource.
    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.
    azure_api_version str
    The Azure API version of the resource.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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.

    Look up Existing Kpi Resource

    Get an existing Kpi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Kpi
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Kpi
    func GetKpi(ctx *Context, name string, id IDInput, state *KpiState, opts ...ResourceOption) (*Kpi, error)
    public static Kpi Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Kpi get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingKpi:    type: azure-native:customerinsights:Kpi    get:      id: ${id}
    import {
      to = azure-native_customerinsights_kpi.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state KpiState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    CalculationWindowTypes

    The calculation window.

    NameValue
    LifetimeLifetime
    HourHour
    DayDay
    WeekWeek
    MonthMonth
    NameValue
    CalculationWindowTypesLifetimeLifetime
    CalculationWindowTypesHourHour
    CalculationWindowTypesDayDay
    CalculationWindowTypesWeekWeek
    CalculationWindowTypesMonthMonth
    Value
    Lifetime
    Hour
    Day
    Week
    Month
    NameValue
    LifetimeLifetime
    HourHour
    DayDay
    WeekWeek
    MonthMonth
    NameValue
    LifetimeLifetime
    HourHour
    DayDay
    WeekWeek
    MonthMonth
    NameValue
    LIFETIMELifetime
    HOURHour
    DAYDay
    WEEKWeek
    MONTHMonth
    Value
    Lifetime
    Hour
    Day
    Week
    Month

    EntityTypes

    Type of entity.

    NameValue
    NoneNone
    ProfileProfile
    InteractionInteraction
    RelationshipRelationship
    NameValue
    EntityTypesNoneNone
    EntityTypesProfileProfile
    EntityTypesInteractionInteraction
    EntityTypesRelationshipRelationship
    Value
    None
    Profile
    Interaction
    Relationship
    NameValue
    NoneNone
    ProfileProfile
    InteractionInteraction
    RelationshipRelationship
    NameValue
    NoneNone
    ProfileProfile
    InteractionInteraction
    RelationshipRelationship
    NameValue
    NONENone
    PROFILEProfile
    INTERACTIONInteraction
    RELATIONSHIPRelationship
    Value
    None
    Profile
    Interaction
    Relationship

    KpiAlias, KpiAliasArgs

    The KPI alias.

    AliasName string
    KPI alias name.
    Expression string
    The expression.
    AliasName string
    KPI alias name.
    Expression string
    The expression.
    alias_name string
    KPI alias name.
    expression string
    The expression.
    aliasName String
    KPI alias name.
    expression String
    The expression.
    aliasName string
    KPI alias name.
    expression string
    The expression.
    alias_name str
    KPI alias name.
    expression str
    The expression.
    aliasName String
    KPI alias name.
    expression String
    The expression.

    KpiAliasResponse

    The KPI alias.

    AliasName string
    KPI alias name.
    Expression string
    The expression.
    AliasName string
    KPI alias name.
    Expression string
    The expression.
    alias_name string
    KPI alias name.
    expression string
    The expression.
    aliasName String
    KPI alias name.
    expression String
    The expression.
    aliasName string
    KPI alias name.
    expression string
    The expression.
    alias_name str
    KPI alias name.
    expression str
    The expression.
    aliasName String
    KPI alias name.
    expression String
    The expression.

    KpiExtract, KpiExtractArgs

    The KPI extract.

    Expression string
    The expression.
    ExtractName string
    KPI extract name.
    Expression string
    The expression.
    ExtractName string
    KPI extract name.
    expression string
    The expression.
    extract_name string
    KPI extract name.
    expression String
    The expression.
    extractName String
    KPI extract name.
    expression string
    The expression.
    extractName string
    KPI extract name.
    expression str
    The expression.
    extract_name str
    KPI extract name.
    expression String
    The expression.
    extractName String
    KPI extract name.

    KpiExtractResponse

    The KPI extract.

    Expression string
    The expression.
    ExtractName string
    KPI extract name.
    Expression string
    The expression.
    ExtractName string
    KPI extract name.
    expression string
    The expression.
    extract_name string
    KPI extract name.
    expression String
    The expression.
    extractName String
    KPI extract name.
    expression string
    The expression.
    extractName string
    KPI extract name.
    expression str
    The expression.
    extract_name str
    KPI extract name.
    expression String
    The expression.
    extractName String
    KPI extract name.

    KpiFunctions

    The computation function for the KPI.

    NameValue
    SumSum
    AvgAvg
    MinMin
    MaxMax
    LastLast
    CountCount
    NoneNone
    CountDistinctCountDistinct
    NameValue
    KpiFunctionsSumSum
    KpiFunctionsAvgAvg
    KpiFunctionsMinMin
    KpiFunctionsMaxMax
    KpiFunctionsLastLast
    KpiFunctionsCountCount
    KpiFunctionsNoneNone
    KpiFunctionsCountDistinctCountDistinct
    Value
    Sum
    Avg
    Min
    Max
    Last
    Count
    None
    CountDistinct
    NameValue
    SumSum
    AvgAvg
    MinMin
    MaxMax
    LastLast
    CountCount
    NoneNone
    CountDistinctCountDistinct
    NameValue
    SumSum
    AvgAvg
    MinMin
    MaxMax
    LastLast
    CountCount
    NoneNone
    CountDistinctCountDistinct
    NameValue
    SUMSum
    AVGAvg
    MINMin
    MAXMax
    LASTLast
    COUNTCount
    NONENone
    COUNT_DISTINCTCountDistinct
    Value
    Sum
    Avg
    Min
    Max
    Last
    Count
    None
    CountDistinct

    KpiGroupByMetadataResponse

    The KPI GroupBy field metadata.

    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.
    display_name map(string)
    The display name.
    field_name string
    The name of the field.
    field_type 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

    The KPI participant profile metadata.

    TypeName string
    Name of the type.
    TypeName string
    Name of the type.
    type_name string
    Name of the type.
    typeName String
    Name of the type.
    typeName string
    Name of the type.
    type_name str
    Name of the type.
    typeName String
    Name of the type.

    KpiThresholds, KpiThresholdsArgs

    Defines the KPI Threshold limits.

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

    KpiThresholdsResponse

    Defines the KPI Threshold limits.

    IncreasingKpi bool
    Whether or not the KPI is an increasing KPI.
    LowerLimit double
    The lower threshold limit.
    UpperLimit double
    The upper threshold limit.
    IncreasingKpi bool
    Whether or not the KPI is an increasing KPI.
    LowerLimit float64
    The lower threshold limit.
    UpperLimit float64
    The upper threshold limit.
    increasing_kpi bool
    Whether or not the KPI is an increasing KPI.
    lower_limit number
    The lower threshold limit.
    upper_limit number
    The upper threshold limit.
    increasingKpi Boolean
    Whether or not the KPI is an increasing KPI.
    lowerLimit Double
    The lower threshold limit.
    upperLimit Double
    The upper threshold limit.
    increasingKpi boolean
    Whether or not the KPI is an increasing KPI.
    lowerLimit number
    The lower threshold limit.
    upperLimit number
    The upper threshold limit.
    increasing_kpi bool
    Whether or not the KPI is an increasing KPI.
    lower_limit float
    The lower threshold limit.
    upper_limit float
    The upper threshold limit.
    increasingKpi Boolean
    Whether or not the KPI is an increasing KPI.
    lowerLimit Number
    The lower threshold limit.
    upperLimit 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} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo Azure Native
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.32.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial