Kpi interface
Interface representing a Kpi.
Methods
| begin |
Creates a KPI or updates an existing KPI in the hub. |
| begin |
Creates a KPI or updates an existing KPI in the hub. |
| begin |
Deletes a KPI in the hub. |
| begin |
Deletes a KPI in the hub. |
| get(string, string, string, Kpi |
Gets a KPI in the hub. |
| list |
Gets all the KPIs in the specified hub. |
| reprocess(string, string, string, Kpi |
Reprocesses the Kpi values of the specified KPI. |
Method Details
beginCreateOrUpdate(string, string, string, KpiResourceFormat, KpiCreateOrUpdateOptionalParams)
Creates a KPI or updates an existing KPI in the hub.
function beginCreateOrUpdate(resourceGroupName: string, hubName: string, kpiName: string, parameters: KpiResourceFormat, options?: KpiCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<KpiResourceFormat>, KpiResourceFormat>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- kpiName
-
string
The name of the KPI.
- parameters
- KpiResourceFormat
Parameters supplied to the create/update KPI operation.
- options
- KpiCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<KpiResourceFormat>, KpiResourceFormat>>
beginCreateOrUpdateAndWait(string, string, string, KpiResourceFormat, KpiCreateOrUpdateOptionalParams)
Creates a KPI or updates an existing KPI in the hub.
function beginCreateOrUpdateAndWait(resourceGroupName: string, hubName: string, kpiName: string, parameters: KpiResourceFormat, options?: KpiCreateOrUpdateOptionalParams): Promise<KpiResourceFormat>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- kpiName
-
string
The name of the KPI.
- parameters
- KpiResourceFormat
Parameters supplied to the create/update KPI operation.
- options
- KpiCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<KpiResourceFormat>
beginDelete(string, string, string, KpiDeleteOptionalParams)
Deletes a KPI in the hub.
function beginDelete(resourceGroupName: string, hubName: string, kpiName: string, options?: KpiDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- kpiName
-
string
The name of the KPI.
- options
- KpiDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, KpiDeleteOptionalParams)
Deletes a KPI in the hub.
function beginDeleteAndWait(resourceGroupName: string, hubName: string, kpiName: string, options?: KpiDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- kpiName
-
string
The name of the KPI.
- options
- KpiDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, KpiGetOptionalParams)
Gets a KPI in the hub.
function get(resourceGroupName: string, hubName: string, kpiName: string, options?: KpiGetOptionalParams): Promise<KpiResourceFormat>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- kpiName
-
string
The name of the KPI.
- options
- KpiGetOptionalParams
The options parameters.
Returns
Promise<KpiResourceFormat>
listByHub(string, string, KpiListByHubOptionalParams)
Gets all the KPIs in the specified hub.
function listByHub(resourceGroupName: string, hubName: string, options?: KpiListByHubOptionalParams): PagedAsyncIterableIterator<KpiResourceFormat, KpiResourceFormat[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- options
- KpiListByHubOptionalParams
The options parameters.
Returns
reprocess(string, string, string, KpiReprocessOptionalParams)
Reprocesses the Kpi values of the specified KPI.
function reprocess(resourceGroupName: string, hubName: string, kpiName: string, options?: KpiReprocessOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- kpiName
-
string
The name of the KPI.
- options
- KpiReprocessOptionalParams
The options parameters.
Returns
Promise<void>