@pulumi/azure-native/customerinsights/getKpi.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets a KPI in the hub.
 *
 * Uses Azure REST API version 2017-04-26.
 */
export declare function getKpi(args: GetKpiArgs, opts?: pulumi.InvokeOptions): Promise<GetKpiResult>;
export interface GetKpiArgs {
    /**
     * The name of the hub.
     */
    hubName: string;
    /**
     * The name of the KPI.
     */
    kpiName: string;
    /**
     * The name of the resource group.
     */
    resourceGroupName: string;
}
/**
 * The KPI resource format.
 */
export interface GetKpiResult {
    /**
     * The aliases.
     */
    readonly aliases?: outputs.customerinsights.KpiAliasResponse[];
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * The calculation window.
     */
    readonly calculationWindow: string;
    /**
     * Name of calculation window field.
     */
    readonly calculationWindowFieldName?: string;
    /**
     * Localized description for the KPI.
     */
    readonly description?: {
        [key: string]: string;
    };
    /**
     * Localized display name for the KPI.
     */
    readonly displayName?: {
        [key: string]: string;
    };
    /**
     * The mapping entity type.
     */
    readonly entityType: string;
    /**
     * The mapping entity name.
     */
    readonly entityTypeName: string;
    /**
     * The computation expression for the KPI.
     */
    readonly expression: string;
    /**
     * The KPI extracts.
     */
    readonly extracts?: outputs.customerinsights.KpiExtractResponse[];
    /**
     * The filter expression for the KPI.
     */
    readonly filter?: string;
    /**
     * The computation function for the KPI.
     */
    readonly function: string;
    /**
     * the group by properties for the KPI.
     */
    readonly groupBy?: string[];
    /**
     * The KPI GroupByMetadata.
     */
    readonly groupByMetadata: outputs.customerinsights.KpiGroupByMetadataResponse[];
    /**
     * Resource ID.
     */
    readonly id: string;
    /**
     * The KPI name.
     */
    readonly kpiName: string;
    /**
     * Resource name.
     */
    readonly name: string;
    /**
     * The participant profiles.
     */
    readonly participantProfilesMetadata: outputs.customerinsights.KpiParticipantProfilesMetadataResponse[];
    /**
     * Provisioning state.
     */
    readonly provisioningState: string;
    /**
     * The hub name.
     */
    readonly tenantId: string;
    /**
     * The KPI thresholds.
     */
    readonly thresHolds?: outputs.customerinsights.KpiThresholdsResponse;
    /**
     * Resource type.
     */
    readonly type: string;
    /**
     * The unit of measurement for the KPI.
     */
    readonly unit?: string;
}
/**
 * Gets a KPI in the hub.
 *
 * Uses Azure REST API version 2017-04-26.
 */
export declare function getKpiOutput(args: GetKpiOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKpiResult>;
export interface GetKpiOutputArgs {
    /**
     * The name of the hub.
     */
    hubName: pulumi.Input<string>;
    /**
     * The name of the KPI.
     */
    kpiName: pulumi.Input<string>;
    /**
     * The name of the resource group.
     */
    resourceGroupName: pulumi.Input<string>;
}