@azure/ai-metrics-advisor package

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

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

Credential used to authenticate and authorize with Metrics Advisor service

Contains response data for the listAlertConfigs operation.

Contains response data for the listAlertsForAlertConfiguration operation.

Contains response data for the listAnomalies operation.

Represents an alert reported by Metrics Advisor service.

Represents an anomaly alert configuration.

Represents a metric anomaly detection configuration.

Represents patch type for metric anomaly detection configuration.

Represents an incident reported by Metrics Advisor service.

Represents Basic Authentication Type for Azure Data Explorer Source

Represents Managed Identity Authentication Type for Azure Data Explorer Source

Represents Service Principal Authentication Type for Azure Data Explorer Source

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

Options for creating data feed

Contains response data for the listCredentials operation.

Represents a dimension of an ingested data feed

Track the progress for Datafeed Ingestion

Specifies ingestion settings for a data feed.

Represents a metric of an ingested data feed

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

Contains response data for the listDataFeeds operation.

Represents an anomaly point detected by Metrics Advisor service.

Data Source Credential

DataLake Gen2 Shared Key DataSource Credential User is required to specify accountKey for Create. accountKey being a secret is not returned by service.

DataLake Gen2 Shared Key DataSource Credential Patch

Service Principal DataSource Credential User is required to specify clientSecret for Create. clientSecret being a secret is not returned by service.

Service Principal in KeyVault DataSource Credential User is required to specify keyVaultClientSecret for Create. keyVaultClientSecret being a secret is not returned by service.

Service Principal in KeyVault DataSource Credential Patch

Service Principal DataSource Credential Patch

SqlServer Data Source Credential User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

SqlServer Data Source Credential Patch

Represents properties common to anomaly detection conditions.

Represents patch type for properties common to anomaly detection conditions.

Contains response data for the listAnomalyDetectionConfigurations operation.

Contains response data for the listDimensionValues operation.

Parameters for Email Hook

Represents Enrichment Status

Options for retreiving metric enriched series data

Contains response data for the getMetricEnrichedSeriesData operation.

Options for retreiving metric series data

Contains response data for the getMetricSeriesData operation.

Contains response data for the listHooks operation.

Represents the root cause of an incident.

Contains response data for the listIncidents operation.

Contains response data for the ListDataFeedIngestionStatus operation.

Options for listing alerts

Options for listing anomalies for alert configurations

Options for listing anomalies for detection configurations

Options for listing dimension values for detection configurations

Options for listing data feed ingestion status

Options for listing data feeds

Options for listing data source credentials

Options for listing feedbacks

Options for listing hooks

Options for listing incidents for an alert

Options for listing incidents for detection configurations

Options for listing dimension values of a metric

Options for listing metric enrichment status

Options for listing series definitions of a metric

Defines alerting settings for anomalies detected by a detection configuration.

Defines conditions to decide whether the detected anomalies should be included in an alert or not.

Represents Conditions to snooze Alerts

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

Contains response data for the listMetricEnrichmentStatus operation.

Represents properties common to all metric feedback types.

Contains response data for the listMetricFeedbacks operation.

Represents a segment of a metric time series.

Defines a metric time series

Contains response data for the listMetricSeries operation.

Client options used to configure API requests.

Client options used to configure Metrics Advisor API requests.

Interface parameters for updateKey function

Represents properties common to hooks.

Alert Severity Condition

Represents Conditions to filter severity

Represents Smart Condition

Represents Basic Authentication for Sql Server datafeed source

Represents Azure SQL Connection String Authentication for Sql Server datafeed source

Represents Managed Identity Authentication for Sql Server datafeed source

Represents Service Principal Authentication for Sql Server datafeed source

Represents Service Principal in Keyvault Authentication for Sql Server datafeed source

Represents Suppress Condition

Group Scope for Top N values

Mode to use when querying alerts by time.

Defines values for AnomalyDetectorDirection.

Severity of an anomaly or incident.

Status of an anomaly or incident.

Defines values for AnomalyValue.

Represents an Azure Application Insights data source. User is required to specify azureCloud, applicationId and apiKey for Create. apiKey being a secret is not returned by service.

Represents an Azure Blob Storage data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Represents an Azure CosmosDB data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Represents Authentication Type Union for Azure Data Explorer Source

Represents an Azure Data Explorer data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Represents Authentication Type Union for Azure DataLake Storage Gen2 Source

Represents an Azure DataLake Storage Gen2 data source.

Represents an Azure Event Hubs data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Represents Authentication Type Union for Azure Log Analytics data source

Represents an Azure Log Analytics data source.

Represents an Azure Table data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Represents the Change threshold detection condition.

Access mode of the data feed

Defines values for DataFeedAutoRollupMethod.

describes the input to Create Data Feed operation

Defines values for EntityStatus.

Granularity type of a data feed.

Specifies how missing data points are filled.

Represents the input type to the Update Data Feed operation.

Specifies the rollup settings for a data feed.

A union type of all supported data sources.

A alias type of supported data sources to pass to Update Data Feed operation.

DataFeed Status

Represents Basic Authentication Type for Azure DataLake Storage Gen2 Source User is required to specify accountKey for Create with Basic type. accountKey being a secret is not returned by service.

Represents Managed Identity Authentication Type for Azure DataLake Storage Gen2 Source

Represents Service Principal Authentication Type for Azure DataLake Storage Gen2 Source

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

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

Data Source Credential Entity Union Type

DataSource credential patch types

Defines values for DataSourceType.

The logical operator to apply across anomaly detection conditions.

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"

Represents Email hook

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

Defines values for FeedbackQueryTimeMode.

Defines values for FeedbackType.

Contains response data for the getIncidentRootCause operation.

Contains response data for the getDataFeedIngestionProgress operation.

Represents the hard threshold detection condition.

Represents an InfluxDB data source. User is required to specify password for Create. password being a secret is not returned by service.

Defines values for IngestionStatusType.

Represents Basic Authentication Type for Azure Log Analytics Source. User is required to specify clientSecret for Create with Basic type. clientSecret being a secret will not be returned by the service.

Represents Service Principal Authentication Type for Azure Log Analytics Source

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

The logical operator to apply across multiple MetricAlertConfiguration

Defines the anomaly alert scope.

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

Defines the Boundary Conditions for the Metric

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

Represents comment feedback.

Detection condition for all time series of a metric.

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

A union type of all metric feedback types.

Represents feedback regarding period.

Detection condition for a series group.

Detection condition for a specific time series.

Represents a Metrics Advisor data feed.

Represents a MongoDB data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Represents a MySQL data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

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

A union type of all supported hooks

Represents a PostgreSQL data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service.

Defines values for Severity.

Defines values for SnoozeScope.

Represents Authentication Type Union for Sql Server datafeed source

Represents a SQL Server data source.

Represents an Unknown data source.

Represents Webhook hook

Represents Webhook specific patch input to the Update Hook operation.