@azure/ai-metrics-advisor package

Classes

MetricsAdvisorAdministrationClient

Client class for interacting with Azure Metrics Advisor Service to perform management operations

MetricsAdvisorClient

Client class for interacting with Azure Metrics Advisor Service to query alerts/incidents/anomalies, diagnose incidents, provide metric feedback

MetricsAdvisorKeyCredential

Credential used to authenticate and authorize with Metrics Advisor service

Interfaces

AlertConfigurationsPageResponse

Contains response data for the listAlertConfigs operation.

AlertsPageResponse

Contains response data for the listAlertsForAlertConfiguration operation.

AnomaliesPageResponse

Contains response data for the listAnomalies operation.

AnomalyAlert

Represents an alert reported by Metrics Advisor service.

AnomalyAlertConfiguration

Represents an anomaly alert configuration.

AnomalyDetectionConfiguration

Represents a metric anomaly detection configuration.

AnomalyDetectionConfigurationPatch

Represents patch type for metric anomaly detection configuration.

AnomalyIncident

Represents an incident reported by Metrics Advisor service.

AzureDataExplorerAuthBasic

Represents Basic Authentication Type for Azure Data Explorer Source

AzureDataExplorerAuthManagedIdentity

Represents Managed Identity Authentication Type for Azure Data Explorer Source

AzureDataExplorerAuthServicePrincipal

Represents Service Principal Authentication Type for Azure Data Explorer Source

AzureDataExplorerAuthServicePrincipalInKeyVault

Represents Service Principal in KV Authentication Type for Azure Data Explorer Source

CreateDataFeedOptions

Options for creating data feed

CredentialsPageResponse

Contains response data for the listCredentials operation.

DataFeedDimension

Represents a dimension of an ingested data feed

DataFeedIngestionProgress
DataFeedIngestionSettings

Specifies ingestion settings for a data feed.

DataFeedMetric

Represents a metric of an ingested data feed

DataFeedSchema

Specifies metrics, dimensions, and timestamp columns of a data feed.

DataFeedsPageResponse

Contains response data for the listDataFeeds operation.

DataLakeGen2SharedKeyDatasourceCredential

DataLake Gen2 Shared Key Datasource Credential

DataLakeGen2SharedKeyDatasourceCredentialPatch

DataLake Gen2 Shared Key Datasource Credential Patch

DataPointAnomaly

Represents an anomaly point detected by Metrics Advisor service.

DatasourceCredential

Data Source Credential

DetectionConditionsCommon

Represents properties common to anomaly detection conditions.

DetectionConditionsCommonPatch

Represents patch type for properties common to anomaly detection conditions.

DetectionConfigurationsPageResponse

Contains response data for the listAnomalyDetectionConfigurations operation.

DimensionValuesPageResponse

Contains response data for the listDimensionValues operation.

EmailHookParameter
EnrichmentStatus
GetMetricEnrichedSeriesDataOptions

Options for retreiving metric enriched series data

GetMetricEnrichedSeriesDataResponse

Contains response data for the getMetricEnrichedSeriesData operation.

GetMetricSeriesDataOptions

Options for retreiving metric series data

GetMetricSeriesDataResponse

Contains response data for the getMetricSeriesData operation.

HooksPageResponse

Contains response data for the listHooks operation.

IncidentRootCause

Represents the root cause of an incident.

IncidentsPageResponse

Contains response data for the listIncidents operation.

IngestionStatus
IngestionStatusPageResponse

Contains response data for the ListDataFeedIngestionStatus operation.

ListAlertsOptions

Options for listing alerts

ListAnomaliesForAlertConfigurationOptions

Options for listing anomalies for alert configurations

ListAnomaliesForDetectionConfigurationOptions

Options for listing anomalies for detection configurations

ListAnomalyDimensionValuesOptions

Options for listing dimension values for detection configurations

ListDataFeedIngestionStatusOptions

Options for listing data feed ingestion status

ListDataFeedsOptions

Options for listing data feeds

ListDatasourceCredentialsOptions

Options for listing data source credentials

ListFeedbackOptions

Options for listing feedbacks

ListHooksOptions

Options for listing hooks

ListIncidentsForAlertOptions

Options for listing incidents for an alert

ListIncidentsForDetectionConfigurationOptions

Options for listing incidents for detection configurations

ListMetricDimensionValuesOptions

Options for listing dimension values of a metric

ListMetricEnrichmentStatusOptions

Options for listing metric enrichment status

ListMetricSeriesDefinitionsOptions

Options for listing series definitions of a metric

MetricAlertConfiguration
MetricAnomalyAlertConditions
MetricAnomalyAlertSnoozeCondition
MetricEnrichedSeriesData

Represents a segment of metric time series data enriched by the Metrics Advisor service.

MetricEnrichmentStatusPageResponse

Contains response data for the listMetricEnrichmentStatus operation.

MetricFeedbackCommon

Represents properties common to all metric feedback types.

MetricFeedbackPageResponse

Contains response data for the listMetricFeedbacks operation.

MetricSeriesData

Represents a segment of a metric time series.

MetricSeriesDefinition

Defines a metric time series

MetricSeriesPageResponse

Contains response data for the listMetricSeries operation.

MetricsAdvisorAdministrationClientOptions

Client options used to configure API requests.

MetricsAdvisorClientOptions

Client options used to configure Metrics Advisor API requests.

MetricsAdvisorKeys

Interface parameters for updateKey function

NotificationHook

Represents properties common to hooks.

ServicePrincipalDatasourceCredential

Service Principal Datasource Credential

ServicePrincipalDatasourceCredentialPatch

Service Principal Datasource Credential Patch

ServicePrincipalInKeyVaultDatasourceCredential

Service Principal in KeyVault Datasource Credential

ServicePrincipalInKeyVaultDatasourceCredentialPatch

Service Principal in KeyVault Datasource Credential Patch

SeverityCondition
SeverityFilterCondition
SmartDetectionCondition
SqlServerAuthBasic

Represents Basic Authentication for Sql Server datafeed source

SqlServerAuthConnectionString

Represents Azure SQL Connection String Authentication for Sql Server datafeed source

SqlServerAuthManagedIdentity

Represents Managed Identity Authentication for Sql Server datafeed source

SqlServerAuthServicePrincipal

Represents Service Principal Authentication for Sql Server datafeed source

SqlServerAuthServicePrincipalInKeyVault

Represents Service Principal in Keyvault Authentication for Sql Server datafeed source

SqlServerConnectionStringDatasourceCredential

SqlServer Data Source Credential

SqlServerConnectionStringDatasourceCredentialPatch

SqlServer Data Source Credential Patch

SuppressCondition
TopNGroupScope
WebhookHookParameter

Type Aliases

AlertQueryTimeMode

Mode to use when querying alerts by time.

AnomalyDetectorDirection

Defines values for AnomalyDetectorDirection.

AnomalySeverity

Severity of an anomaly or incident.

AnomalyStatus

Status of an anomaly or incident.

AnomalyValue

Defines values for AnomalyValue.

AzureApplicationInsightsDataFeedSource

Represents an Azure Application Insights data source.

AzureBlobDataFeedSource

Represents an Azure Blob Storage data source.

AzureCosmosDbDataFeedSource

Represents an Azure CosmosDB data source.

AzureDataExplorerAuthTypes

Represents Authentication Type Union for Azure Data Explorer Source

AzureDataExplorerDataFeedSource

Represents an Azure Data Explorer data source.

AzureDataLakeStorageGen2AuthTypes

Represents Authentication Type Union for Azure DataLake Storage Gen2 Source

AzureDataLakeStorageGen2DataFeedSource

Represents an Azure DataLake Storage Gen2 data source.

AzureEventHubsDataFeedSource

Represents an Azure Event Hubs data source.

AzureLogAnalyticsAuthTypes

Represents Authentication Type Union for Azure Log Analytics data source

AzureLogAnalyticsDataFeedSource

Represents an Azure Log Analytics data source.

AzureTableDataFeedSource

Represents an Azure Table data source.

ChangeThresholdConditionUnion

Represents the Change threshold detection condition.

DataFeed

Represents a Metrics Advisor data feed.

DataFeedAccessMode

Access mode of the data feed

DataFeedDescriptor

describes the input to Create Data Feed operation

DataFeedDetailStatus

Defines values for EntityStatus.

DataFeedGranularity

Granularity type of a data feed.

DataFeedMissingDataPointFillSettings

Specifies how missing data points are filled.

DataFeedPatch

Represents the input type to the Update Data Feed operation.

DataFeedRollupMethod

Defines values for DataFeedRollupMethod.

DataFeedRollupSettings

Specifies the rollup settings for a data feed.

DataFeedSource

A union type of all supported data sources.

DataFeedSourcePatch

A alias type of supported data sources to pass to Update Data Feed operation. When not changing the data source type, the dataSourceParameter is not required. When changing to a different data source type, both dataSourceType and dataSourceParameter are required.

DataFeedStatus

DataFeed Status

DataLakeStorageGen2AuthBasic

Represents Basic Authentication Type for Azure DataLake Storage Gen2 Source

DataLakeStorageGen2AuthManagedIdentity

Represents Managed Identity Authentication Type for Azure DataLake Storage Gen2 Source

DataLakeStorageGen2AuthServicePrincipal

Represents Service Principal Authentication Type for Azure DataLake Storage Gen2 Source

DataLakeStorageGen2AuthServicePrincipalInKeyVault

Represents Service Principal in KV Authentication Type for Azure DataLake Storage Gen2 Source

DataLakeStorageGen2AuthSharedKey

Represents Shared Key in KV Authentication Type for Azure DataLake Storage Gen2 Source

DataSourceType

Defines values for DataSourceType.

DatasourceCredentialPatch

Datasource credential patch types

DatasourceCredentialUnion
DetectionConditionsOperator

The logical operator to apply across anomaly detection conditions.

DimensionKey

String key-value pairs that consist of dimension names and dimension values. For a metric with two dimensions: city and category, Examples include

{ { city: "Tokyo", category: "Handmade" } } - identifies one time series { { city: "Karachi" } } - identifies all time series with city === "Karachi"

EmailNotificationHook

Represents Email hook

EmailNotificationHookPatch

Represents Email hook specific patch input to the Update Hook operation.

FeedbackQueryTimeMode

Defines values for FeedbackQueryTimeMode.

FeedbackType

Defines values for FeedbackType.

GetAnomalyAlertConfigurationResponse

Contains response data for the getAnomalyAlertConfiguration operation.

GetAnomalyDetectionConfigurationResponse

Contains response data for the getAnomalyDetectionConfiguration operation.

GetCredentialEntityResponse

Contains response data for the getCredentialEntity operation.

GetDataFeedResponse

Contains response data for the getDataFeed operation.

GetFeedbackResponse

Contains response data for the getFeedback operation.

GetHookResponse

Contains response data for the getHook operation.

GetIncidentRootCauseResponse

Contains response data for the getIncidentRootCause operation.

GetIngestionProgressResponse

Contains response data for the getDataFeedIngestionProgress operation.

HardThresholdConditionUnion

Represents the hard threshold detection condition.

InfluxDbDataFeedSource

Represents an InfluxDB data source.

IngestionStatusType

Defines values for IngestionStatusType.

LogAnalyticsAuthBasic

Represents Basic Authentication Type for Azure Log Analytics Source

LogAnalyticsAuthServicePrincipal

Represents Service Principal Authentication Type for Azure Log Analytics Source

LogAnalyticsAuthServicePrincipalInKeyVault

Represents Service Principal Authentication In KeyVault Type for Azure Log Analytics Source

MetricAnomalyAlertConfigurationsOperator

The logical operator to apply across multiple <xref:MetricAlertConfiguration>

MetricAnomalyAlertScope

Defines the anomaly alert scope.

MetricAnomalyFeedback

Represents feedback of whether data points within the time range should be considered anomalies or not.

MetricBoundaryCondition

Defines the

MetricChangePointFeedback

Represents feedback of whether data points within the time range should be considered change point or not.

MetricCommentFeedback

Represents comment feedback.

MetricDetectionCondition

Detection condition for all time series of a metric.

MetricDetectionConditionPatch

Detection condition patch type for all time series of a metric.

MetricFeedbackUnion

A union type of all metric feedback types.

MetricPeriodFeedback

Represents feedback regarding period.

MetricSeriesGroupDetectionCondition

Detection condition for a series group.

MetricSingleSeriesDetectionCondition

Detection condition for a specific time series.

MongoDbDataFeedSource

Represents a MongoDB data source.

MySqlDataFeedSource

Represents a MySQL data source.

NotificationHookPatch

Represents properties common to the patch input to the Update Hook operation.

NotificationHookUnion

A union type of all supported hooks

PostgreSqlDataFeedSource

Represents a PostgreSQL data source.

Severity

Defines values for Severity.

SnoozeScope

Defines values for SnoozeScope.

SqlServerAuthTypes

Represents Authentication Type Union for Sql Server datafeed source

SqlServerDataFeedSource

Represents a SQL Server data source.

UnknownDataFeedSource

Represents an Unknown data source.

WebNotificationHook

Represents Webhook hook

WebNotificationHookPatch

Represents Webhook specific patch input to the Update Hook operation.