DataFeed Class

Reference

Definition

Namespace:: Azure.AI.MetricsAdvisor.Models

Assembly:: Azure.AI.MetricsAdvisor.dll

Package:: Azure.AI.MetricsAdvisor v1.1.0

Source:: DataFeed.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A data feed is the entry point of data for the Metrics Advisor service and, therefore, the first entity to be created when setting up your resource. It periodically ingests data from a DataFeedSource and monitors it in search of anomalies.

public class DataFeed

type DataFeed = class

Public Class DataFeed

Inheritance: Object
DataFeed

Remarks

In order to create a data feed, you must set up at least the properties Name, DataSource, Granularity, IngestionSettings, and Schema, and pass this instance to the method CreateDataFeedAsync(DataFeed, CancellationToken).

Constructors

DataFeed()

Initializes a new instance of the DataFeed class.

Properties

AccessMode	The access mode for this DataFeed. Only Private and Public are supported. Defaults to Private.
ActionLinkTemplate	Defines actionable HTTP URLs, which consist of the placeholders %datafeed, %metric, %timestamp, %detect_config, and %tagset. You can use the template to redirect from an anomaly or an incident to a specific URL to drill down. See the documentation for details. Defaults to an empty string.
Administrators	The administrators of this DataFeed. Administrators have total control over a data feed, being allowed to update, delete, or pause them. Each element in this list represents a user with administrator access, but the value of each `string` element depends on the type of authentication to be used by this administrator when communicating with the service. If MetricsAdvisorKeyCredential authentication will be used, the `string` must be the user's email address. If AAD authentication will be used instead, the `string` must uniquely identify the user's principal. For instance, for a `ClientSecretCredential`, the `string` must be the client ID.
CreatedOn	The date and time, in UTC, when this DataFeed was created.
Creator	The user who created this DataFeed. If MetricsAdvisorKeyCredential authentication was used when creating the data feed, this property contains the email address of the creator. If AAD authentication was used instead, the value of this property uniquely identifies the creator's user principal, but its value depends on the type of credential used. For instance, if a `ClientSecretCredential` is used, it will contain the client ID.
DataSource	The source that periodically provides data to this DataFeed.
Description	A description of this DataFeed. Defaults to an empty string.
Granularity	The frequency with which ingestion from the DataSource will happen.
Id	The unique identifier of this DataFeed.
IngestionSettings	Configures how a DataFeed should ingest data from its DataSource.
IsAdministrator	Whether or not the user who queried the information about this DataFeed is one of its administrators. The complete list of administrators can be consulted in Administrators.
MetricIds	The unique identifiers of the metrics of this DataFeed. Keys are the metric names, and values are their corresponding IDs.
MissingDataPointFillSettings	Configures the behavior of this DataFeed when handling missing points in the data ingested from the DataSource. Defaults to settings with SmartFilling set.
Name	A custom name for this DataFeed to be displayed on the web portal. Data feed names must be unique across the same Metris Advisor resource.
RollupSettings	Configures the behavior of this DataFeed when handling rolled-up ingested data before detecting anomalies.
Schema	Specifies which values, such as metrics and dimensions, will be ingested from the DataFeedSource.
Status	The current ingestion status of this DataFeed. Only Active and Paused are supported.
Viewers	The viewers of this DataFeed. Viewers have read-only access to a data feed. Each element in this list represents a user with viewer access, but the value of each `string` element depends on the type of authentication to be used by this viewer when communicating with the service. If MetricsAdvisorKeyCredential authentication will be used, the `string` must be the user's email address. If AAD authentication will be used instead, the `string` must uniquely identify the user's principal. For instance, for a `ClientSecretCredential`, the `string` must be the client ID.

Applies to

Share via