@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 |
Track the progress for Datafeed Ingestion |
| 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. |
| DataPointAnomaly |
Represents an anomaly point detected by Metrics Advisor service. |
| DataSourceCredentialEntity |
Data Source Credential |
| DataSourceDataLakeGen2SharedKey |
DataLake Gen2 Shared Key DataSource Credential User is required to specify accountKey for Create. accountKey being a secret is not returned by service. |
| DataSourceDataLakeGen2SharedKeyPatch |
DataLake Gen2 Shared Key DataSource Credential Patch |
| DataSourceServicePrincipal |
Service Principal DataSource Credential User is required to specify clientSecret for Create. clientSecret being a secret is not returned by service. |
| DataSourceServicePrincipalInKeyVault |
Service Principal in KeyVault DataSource Credential User is required to specify keyVaultClientSecret for Create. keyVaultClientSecret being a secret is not returned by service. |
| DataSourceServicePrincipalInKeyVaultPatch |
Service Principal in KeyVault DataSource Credential Patch |
| DataSourceServicePrincipalPatch |
Service Principal DataSource Credential Patch |
| DataSourceSqlConnectionString |
SqlServer Data Source Credential User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| DataSourceSqlServerConnectionStringPatch |
SqlServer Data Source Credential Patch |
| 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 |
Parameters for Email Hook |
| EnrichmentStatus |
Represents Enrichment Status |
| 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 |
Defines alerting settings for anomalies detected by a detection configuration. |
| MetricAnomalyAlertConditions |
Defines conditions to decide whether the detected anomalies should be included in an alert or not. |
| MetricAnomalyAlertSnoozeCondition |
Represents Conditions to snooze Alerts |
| 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. |
| SeverityCondition |
Alert Severity Condition |
| SeverityFilterCondition |
Represents Conditions to filter severity |
| SmartDetectionCondition |
Represents Smart Condition |
| 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 |
| SuppressCondition |
Represents Suppress Condition |
| TopNGroupScope |
Group Scope for Top N values |
| 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. User is required to specify azureCloud, applicationId and apiKey for Create. apiKey being a secret is not returned by service. |
| AzureBlobDataFeedSource |
Represents an Azure Blob Storage data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| AzureCosmosDbDataFeedSource |
Represents an Azure CosmosDB data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| AzureDataExplorerAuthTypes |
Represents Authentication Type Union for Azure Data Explorer Source |
| AzureDataExplorerDataFeedSource |
Represents an Azure Data Explorer data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| 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. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| 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. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| ChangeThresholdConditionUnion |
Represents the Change threshold detection condition. |
| DataFeedAccessMode |
Access mode of the data feed |
| DataFeedAutoRollupMethod |
Defines values for DataFeedAutoRollupMethod. |
| 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. |
| 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. |
| DataFeedStatus |
DataFeed Status |
| DataLakeStorageGen2AuthBasic |
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. |
| 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 |
| DataSourceCredentialEntityUnion |
Data Source Credential Entity Union Type |
| DataSourceCredentialPatch |
DataSource credential patch types |
| DataSourceType |
Defines values for DataSourceType. |
| DetectionConditionOperator |
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
|
| 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. |
| 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. User is required to specify password for Create. password being a secret is not returned by service. |
| IngestionStatusType |
Defines values for IngestionStatusType. |
| LogAnalyticsAuthBasic |
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. |
| 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 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 Boundary Conditions for the Metric |
| 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. |
| MetricsAdvisorDataFeed |
Represents a Metrics Advisor data feed. |
| MongoDbDataFeedSource |
Represents a MongoDB data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| MySqlDataFeedSource |
Represents a MySQL data source. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| 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. User is required to specify connectionString for Create. connectionString being a secret is not returned by service. |
| 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. |