Kpi | @azure/arm-customerinsights

Class representing a Kpi.

Hierarchy

Index

Constructors

constructor

Methods

Constructors

constructor

new Kpi(client: CustomerInsightsManagementClientContext): Kpi

- Defined in operations/kpi.ts:20
Create a Kpi.

Parameters
- client: CustomerInsightsManagementClientContext
  
  Reference to the service client.
Returns Kpi

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, hubName: string, kpiName: string, parameters: KpiResourceFormat, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/kpi.ts:170
Creates a KPI or updates an existing KPI in the hub.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, hubName: string, kpiName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/kpi.ts:191
Deletes a KPI in the hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(resourceGroupName: string, hubName: string, kpiName: string, parameters: KpiResourceFormat, options?: msRest.RequestOptionsBase): Promise<Models.KpiCreateOrUpdateResponse>

- Defined in operations/kpi.ts:39
Creates a KPI or updates an existing KPI in the hub.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.KpiCreateOrUpdateResponse>

Promise<Models.KpiCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, hubName: string, kpiName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/kpi.ts:88
Deletes a KPI in the hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(resourceGroupName: string, hubName: string, kpiName: string, options?: msRest.RequestOptionsBase): Promise<Models.KpiGetResponse>
get(resourceGroupName: string, hubName: string, kpiName: string, callback: msRest.ServiceCallback<KpiResourceFormat>): void
get(resourceGroupName: string, hubName: string, kpiName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<KpiResourceFormat>): void

- Defined in operations/kpi.ts:52
Gets a KPI in the hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.KpiGetResponse>

Promise<Models.KpiGetResponse>
- Defined in operations/kpi.ts:59
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- callback: msRest.ServiceCallback<KpiResourceFormat>
  
  The callback
Returns void
- Defined in operations/kpi.ts:67
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<KpiResourceFormat>
  
  The callback
Returns void

listByHub

listByHub(resourceGroupName: string, hubName: string, options?: msRest.RequestOptionsBase): Promise<Models.KpiListByHubResponse>
listByHub(resourceGroupName: string, hubName: string, callback: msRest.ServiceCallback<KpiListResult>): void
listByHub(resourceGroupName: string, hubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<KpiListResult>): void

- Defined in operations/kpi.ts:136
Gets all the KPIs in the specified hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.KpiListByHubResponse>

Promise<Models.KpiListByHubResponse>
- Defined in operations/kpi.ts:142
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- callback: msRest.ServiceCallback<KpiListResult>
  
  The callback
Returns void
- Defined in operations/kpi.ts:149
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<KpiListResult>
  
  The callback
Returns void

listByHubNext

listByHubNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.KpiListByHubNextResponse>
listByHubNext(nextPageLink: string, callback: msRest.ServiceCallback<KpiListResult>): void
listByHubNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<KpiListResult>): void

- Defined in operations/kpi.ts:209
Gets all the KPIs in the specified hub.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.KpiListByHubNextResponse>

Promise<Models.KpiListByHubNextResponse>
- Defined in operations/kpi.ts:214
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<KpiListResult>
  
  The callback
Returns void
- Defined in operations/kpi.ts:220
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<KpiListResult>
  
  The callback
Returns void

reprocess

reprocess(resourceGroupName: string, hubName: string, kpiName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
reprocess(resourceGroupName: string, hubName: string, kpiName: string, callback: msRest.ServiceCallback<void>): void
reprocess(resourceGroupName: string, hubName: string, kpiName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/kpi.ts:101
Reprocesses the Kpi values of the specified KPI.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/kpi.ts:108
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/kpi.ts:116
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- kpiName: string
  
  The name of the KPI.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CustomerInsightsManagementClientContext

Returns Kpi

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

hubName: string

kpiName: string

parameters: KpiResourceFormat

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

hubName: string

kpiName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

resourceGroupName: string

hubName: string

kpiName: string

parameters: KpiResourceFormat

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.KpiCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

hubName: string

kpiName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

get

Parameters

resourceGroupName: string

hubName: string

kpiName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.KpiGetResponse>

Parameters

resourceGroupName: string

hubName: string

kpiName: string

callback: msRest.ServiceCallback<KpiResourceFormat>

Returns void

Parameters

resourceGroupName: string

hubName: string

kpiName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<KpiResourceFormat>

Returns void

listByHub

Parameters

resourceGroupName: string

hubName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.KpiListByHubResponse>

Parameters

resourceGroupName: string

hubName: string

callback: msRest.ServiceCallback<KpiListResult>

Returns void

Parameters

resourceGroupName: string

hubName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<KpiListResult>

Returns void

listByHubNext

Parameters

nextPageLink: string