Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Metrics

Package version

Class representing a Metrics.

Hierarchy

  • Metrics

Index

Constructors

Methods

Constructors

constructor

Methods

get

  • get(appId: string, metricId: Models.MetricId, options?: Models.MetricsGetOptionalParams): Promise<Models.MetricsGetResponse>
  • get(appId: string, metricId: Models.MetricId, callback: msRest.ServiceCallback<MetricsResult>): void
  • get(appId: string, metricId: Models.MetricId, options: MetricsGetOptionalParams, callback: msRest.ServiceCallback<MetricsResult>): void

  • Gets metric values for a single metric

    summary

    Retrieve metric data

    Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • metricId: Models.MetricId

      ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

    • Optional options: Models.MetricsGetOptionalParams

    Returns Promise<Models.MetricsGetResponse>

    Promise<Models.MetricsGetResponse>

  • Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • metricId: Models.MetricId

      ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

    • callback: msRest.ServiceCallback<MetricsResult>

      The callback

    Returns void

  • Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • metricId: Models.MetricId

      ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

    • options: MetricsGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<MetricsResult>

      The callback

    Returns void

getMetadata

  • getMetadata(appId: string, options?: msRest.RequestOptionsBase): Promise<Models.MetricsGetMetadataResponse>
  • getMetadata(appId: string, callback: msRest.ServiceCallback<any>): void
  • getMetadata(appId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<any>): void

  • Gets metadata describing the available metrics

    summary

    Retrieve metric metatadata

    Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.MetricsGetMetadataResponse>

    Promise<Models.MetricsGetMetadataResponse>

  • Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • callback: msRest.ServiceCallback<any>

      The callback

    Returns void

  • Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<any>

      The callback

    Returns void

getMultiple

  • Gets metric values for multiple metrics

    summary

    Retrieve metric data

    Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • body: MetricsPostBodySchema[]

      The batched metrics query.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.MetricsGetMultipleResponse>

    Promise<Models.MetricsGetMultipleResponse>

  • Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • body: MetricsPostBodySchema[]

      The batched metrics query.

    • callback: msRest.ServiceCallback<MetricsResultsItem[]>

      The callback

    Returns void

  • Parameters

    • appId: string

      ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

    • body: MetricsPostBodySchema[]

      The batched metrics query.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MetricsResultsItem[]>

      The callback

    Returns void

Generated using TypeDoc