@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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.
*/
export declare class Kpi extends pulumi.CustomResource {
/**
* Get an existing Kpi resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Kpi;
/**
* Returns true if the given object is an instance of Kpi. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Kpi;
/**
* The aliases.
*/
readonly aliases: pulumi.Output<outputs.customerinsights.KpiAliasResponse[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The calculation window.
*/
readonly calculationWindow: pulumi.Output<string>;
/**
* Name of calculation window field.
*/
readonly calculationWindowFieldName: pulumi.Output<string | undefined>;
/**
* Localized description for the KPI.
*/
readonly description: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Localized display name for the KPI.
*/
readonly displayName: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The mapping entity type.
*/
readonly entityType: pulumi.Output<string>;
/**
* The mapping entity name.
*/
readonly entityTypeName: pulumi.Output<string>;
/**
* The computation expression for the KPI.
*/
readonly expression: pulumi.Output<string>;
/**
* The KPI extracts.
*/
readonly extracts: pulumi.Output<outputs.customerinsights.KpiExtractResponse[] | undefined>;
/**
* The filter expression for the KPI.
*/
readonly filter: pulumi.Output<string | undefined>;
/**
* The computation function for the KPI.
*/
readonly function: pulumi.Output<string>;
/**
* the group by properties for the KPI.
*/
readonly groupBy: pulumi.Output<string[] | undefined>;
/**
* The KPI GroupByMetadata.
*/
readonly groupByMetadata: pulumi.Output<outputs.customerinsights.KpiGroupByMetadataResponse[]>;
/**
* The KPI name.
*/
readonly kpiName: pulumi.Output<string>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The participant profiles.
*/
readonly participantProfilesMetadata: pulumi.Output<outputs.customerinsights.KpiParticipantProfilesMetadataResponse[]>;
/**
* Provisioning state.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The hub name.
*/
readonly tenantId: pulumi.Output<string>;
/**
* The KPI thresholds.
*/
readonly thresHolds: pulumi.Output<outputs.customerinsights.KpiThresholdsResponse | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* The unit of measurement for the KPI.
*/
readonly unit: pulumi.Output<string | undefined>;
/**
* Create a Kpi resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: KpiArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Kpi resource.
*/
export interface KpiArgs {
/**
* The aliases.
*/
aliases?: pulumi.Input<pulumi.Input<inputs.customerinsights.KpiAliasArgs>[]>;
/**
* The calculation window.
*/
calculationWindow: pulumi.Input<enums.customerinsights.CalculationWindowTypes>;
/**
* Name of calculation window field.
*/
calculationWindowFieldName?: pulumi.Input<string>;
/**
* Localized description for the KPI.
*/
description?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Localized display name for the KPI.
*/
displayName?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The mapping entity type.
*/
entityType: pulumi.Input<enums.customerinsights.EntityTypes>;
/**
* The mapping entity name.
*/
entityTypeName: pulumi.Input<string>;
/**
* The computation expression for the KPI.
*/
expression: pulumi.Input<string>;
/**
* The KPI extracts.
*/
extracts?: pulumi.Input<pulumi.Input<inputs.customerinsights.KpiExtractArgs>[]>;
/**
* The filter expression for the KPI.
*/
filter?: pulumi.Input<string>;
/**
* The computation function for the KPI.
*/
function: pulumi.Input<enums.customerinsights.KpiFunctions>;
/**
* the group by properties for the KPI.
*/
groupBy?: pulumi.Input<pulumi.Input<string>[]>;
/**
* 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>;
/**
* The KPI thresholds.
*/
thresHolds?: pulumi.Input<inputs.customerinsights.KpiThresholdsArgs>;
/**
* The unit of measurement for the KPI.
*/
unit?: pulumi.Input<string>;
}