Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. customerinsights
  5. getKpi
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.getKpi

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

Gets a KPI in the hub. Azure REST API version: 2017-04-26.

Using getKpi

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKpi(args: GetKpiArgs, opts?: InvokeOptions): Promise<GetKpiResult>
function getKpiOutput(args: GetKpiOutputArgs, opts?: InvokeOptions): Output<GetKpiResult>
Copy
def get_kpi(hub_name: Optional[str] = None,
            kpi_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKpiResult
def get_kpi_output(hub_name: Optional[pulumi.Input[str]] = None,
            kpi_name: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKpiResult]
Copy
func LookupKpi(ctx *Context, args *LookupKpiArgs, opts ...InvokeOption) (*LookupKpiResult, error)
func LookupKpiOutput(ctx *Context, args *LookupKpiOutputArgs, opts ...InvokeOption) LookupKpiResultOutput
Copy

> Note: This function is named LookupKpi in the Go SDK.

public static class GetKpi 
{
    public static Task<GetKpiResult> InvokeAsync(GetKpiArgs args, InvokeOptions? opts = null)
    public static Output<GetKpiResult> Invoke(GetKpiInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKpiResult> getKpi(GetKpiArgs args, InvokeOptions options)
public static Output<GetKpiResult> getKpi(GetKpiArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:customerinsights:getKpi
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
KpiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the KPI.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
KpiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the KPI.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
kpiName
This property is required.
Changes to this property will trigger replacement.
String
The name of the KPI.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
hubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
kpiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the KPI.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
hub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the hub.
kpi_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the KPI.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
kpiName
This property is required.
Changes to this property will trigger replacement.
String
The name of the KPI.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getKpi Result

The following output properties are available:

CalculationWindow string
The calculation window.
EntityType string
The mapping entity type.
EntityTypeName string
The mapping entity name.
Expression string
The computation expression for the KPI.
Function string
The computation function for the KPI.
GroupByMetadata List<Pulumi.AzureNative.CustomerInsights.Outputs.KpiGroupByMetadataResponse>
The KPI GroupByMetadata.
Id string
Resource ID.
KpiName string
The KPI name.
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.
Aliases List<Pulumi.AzureNative.CustomerInsights.Outputs.KpiAliasResponse>
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.Outputs.KpiExtractResponse>
The KPI extracts.
Filter string
The filter expression for the KPI.
GroupBy List<string>
the group by properties for the KPI.
ThresHolds Pulumi.AzureNative.CustomerInsights.Outputs.KpiThresholdsResponse
The KPI thresholds.
Unit string
The unit of measurement for the KPI.
CalculationWindow string
The calculation window.
EntityType string
The mapping entity type.
EntityTypeName string
The mapping entity name.
Expression string
The computation expression for the KPI.
Function string
The computation function for the KPI.
GroupByMetadata []KpiGroupByMetadataResponse
The KPI GroupByMetadata.
Id string
Resource ID.
KpiName string
The KPI name.
Name string
Resource name.
ParticipantProfilesMetadata []KpiParticipantProfilesMetadataResponse
The participant profiles.
ProvisioningState string
Provisioning state.
TenantId string
The hub name.
Type string
Resource type.
Aliases []KpiAliasResponse
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 []KpiExtractResponse
The KPI extracts.
Filter string
The filter expression for the KPI.
GroupBy []string
the group by properties for the KPI.
ThresHolds KpiThresholdsResponse
The KPI thresholds.
Unit string
The unit of measurement for the KPI.
calculationWindow String
The calculation window.
entityType String
The mapping entity type.
entityTypeName String
The mapping entity name.
expression String
The computation expression for the KPI.
function String
The computation function for the KPI.
groupByMetadata List<KpiGroupByMetadataResponse>
The KPI GroupByMetadata.
id String
Resource ID.
kpiName String
The KPI name.
name String
Resource name.
participantProfilesMetadata List<KpiParticipantProfilesMetadataResponse>
The participant profiles.
provisioningState String
Provisioning state.
tenantId String
The hub name.
type String
Resource type.
aliases List<KpiAliasResponse>
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<KpiExtractResponse>
The KPI extracts.
filter String
The filter expression for the KPI.
groupBy List<String>
the group by properties for the KPI.
thresHolds KpiThresholdsResponse
The KPI thresholds.
unit String
The unit of measurement for the KPI.
calculationWindow string
The calculation window.
entityType string
The mapping entity type.
entityTypeName string
The mapping entity name.
expression string
The computation expression for the KPI.
function string
The computation function for the KPI.
groupByMetadata KpiGroupByMetadataResponse[]
The KPI GroupByMetadata.
id string
Resource ID.
kpiName string
The KPI name.
name string
Resource name.
participantProfilesMetadata KpiParticipantProfilesMetadataResponse[]
The participant profiles.
provisioningState string
Provisioning state.
tenantId string
The hub name.
type string
Resource type.
aliases KpiAliasResponse[]
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 KpiExtractResponse[]
The KPI extracts.
filter string
The filter expression for the KPI.
groupBy string[]
the group by properties for the KPI.
thresHolds KpiThresholdsResponse
The KPI thresholds.
unit string
The unit of measurement for the KPI.
calculation_window str
The calculation window.
entity_type str
The mapping entity type.
entity_type_name str
The mapping entity name.
expression str
The computation expression for the KPI.
function str
The computation function for the KPI.
group_by_metadata Sequence[KpiGroupByMetadataResponse]
The KPI GroupByMetadata.
id str
Resource ID.
kpi_name str
The KPI name.
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.
aliases Sequence[KpiAliasResponse]
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[KpiExtractResponse]
The KPI extracts.
filter str
The filter expression for the KPI.
group_by Sequence[str]
the group by properties for the KPI.
thres_holds KpiThresholdsResponse
The KPI thresholds.
unit str
The unit of measurement for the KPI.
calculationWindow String
The calculation window.
entityType String
The mapping entity type.
entityTypeName String
The mapping entity name.
expression String
The computation expression for the KPI.
function String
The computation function for the KPI.
groupByMetadata List<Property Map>
The KPI GroupByMetadata.
id String
Resource ID.
kpiName String
The KPI name.
name String
Resource name.
participantProfilesMetadata List<Property Map>
The participant profiles.
provisioningState String
Provisioning state.
tenantId String
The hub name.
type String
Resource type.
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.
thresHolds Property Map
The KPI thresholds.
unit String
The unit of measurement for the KPI.

Supporting Types

KpiAliasResponse

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.

KpiExtractResponse

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.

KpiGroupByMetadataResponse

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

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.

KpiThresholdsResponse

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.

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