MetricAnomalyAlertScope.xml

<Type Name="MetricAnomalyAlertScope" FullName="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope">
  <TypeSignature Language="C#" Value="public class MetricAnomalyAlertScope" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MetricAnomalyAlertScope extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" />
  <TypeSignature Language="VB.NET" Value="Public Class MetricAnomalyAlertScope" />
  <TypeSignature Language="F#" Value="type MetricAnomalyAlertScope = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Selects the scope of time series in which an anomaly must be to be included in an alert. In
            order to instantiate an object of this class, one of the following static methods must be used:
            <list type="bullet"><item><see cref="M:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForWholeSeries" /></item><item><see cref="M:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForSeriesGroup(Azure.AI.MetricsAdvisor.Models.DimensionKey)" /></item><item><see cref="M:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForTopNGroup(System.Int32,System.Int32,System.Int32)" /></item></list></summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="CreateScopeForSeriesGroup">
      <MemberSignature Language="C#" Value="public static Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope CreateScopeForSeriesGroup (Azure.AI.MetricsAdvisor.Models.DimensionKey seriesGroupKey);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope CreateScopeForSeriesGroup(class Azure.AI.MetricsAdvisor.Models.DimensionKey seriesGroupKey) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForSeriesGroup(Azure.AI.MetricsAdvisor.Models.DimensionKey)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateScopeForSeriesGroup (seriesGroupKey As DimensionKey) As MetricAnomalyAlertScope" />
      <MemberSignature Language="F#" Value="static member CreateScopeForSeriesGroup : Azure.AI.MetricsAdvisor.Models.DimensionKey -&gt; Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" Usage="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForSeriesGroup seriesGroupKey" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="seriesGroupKey" Type="Azure.AI.MetricsAdvisor.Models.DimensionKey" />
      </Parameters>
      <Docs>
        <param name="seriesGroupKey">
            Defines the set of time series included in this scope. If all possible dimensions are set, the
            key uniquely identifies a single time series for the corresponding metric. If only a subset of
            dimensions are set, the key uniquely identifies a group of time series.
            </param>
        <summary>
            Creates a <see cref="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" /> instance that has a fixed group of time series as the scope.
            </summary>
        <returns>A new <see cref="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" /> instance.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="seriesGroupKey" /> is null.</exception>
      </Docs>
    </Member>
    <Member MemberName="CreateScopeForTopNGroup">
      <MemberSignature Language="C#" Value="public static Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope CreateScopeForTopNGroup (int top, int period, int minimumTopCount);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope CreateScopeForTopNGroup(int32 top, int32 period, int32 minimumTopCount) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForTopNGroup(System.Int32,System.Int32,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateScopeForTopNGroup (top As Integer, period As Integer, minimumTopCount As Integer) As MetricAnomalyAlertScope" />
      <MemberSignature Language="F#" Value="static member CreateScopeForTopNGroup : int * int * int -&gt; Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" Usage="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForTopNGroup (top, period, minimumTopCount)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="top" Type="System.Int32" />
        <Parameter Name="period" Type="System.Int32" />
        <Parameter Name="minimumTopCount" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="top">The value of N in the top N series group.</param>
        <param name="period">The number of latest ingestion timestamps to consider when determining the top N series group.</param>
        <param name="minimumTopCount">
            The number of times a time series must be ranked among the highest series to be considered part of the top N series
            group. This value must be less than or equal to <paramref name="period" />.
            </param>
        <summary>
            Creates a <see cref="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" /> instance that has the top N series group as the scope. For a better
            definition of what this series group is, see <see cref="T:Azure.AI.MetricsAdvisor.Models.TopNGroupScope" />.
            </summary>
        <returns>A new <see cref="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" /> instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateScopeForWholeSeries">
      <MemberSignature Language="C#" Value="public static Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope CreateScopeForWholeSeries ();" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope CreateScopeForWholeSeries() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForWholeSeries" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateScopeForWholeSeries () As MetricAnomalyAlertScope" />
      <MemberSignature Language="F#" Value="static member CreateScopeForWholeSeries : unit -&gt; Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" Usage="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.CreateScopeForWholeSeries " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Creates a <see cref="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" /> instance that has all time series within the associated
            metric as the scope.
            </summary>
        <returns>A new <see cref="T:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope" /> instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ScopeType">
      <MemberSignature Language="C#" Value="public Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScopeType ScopeType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScopeType ScopeType" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.ScopeType" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ScopeType As MetricAnomalyAlertScopeType" />
      <MemberSignature Language="F#" Value="member this.ScopeType : Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScopeType" Usage="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.ScopeType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScopeType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The type of scope.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SeriesGroupInScope">
      <MemberSignature Language="C#" Value="public Azure.AI.MetricsAdvisor.Models.DimensionKey SeriesGroupInScope { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Azure.AI.MetricsAdvisor.Models.DimensionKey SeriesGroupInScope" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.SeriesGroupInScope" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SeriesGroupInScope As DimensionKey" />
      <MemberSignature Language="F#" Value="member this.SeriesGroupInScope : Azure.AI.MetricsAdvisor.Models.DimensionKey" Usage="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.SeriesGroupInScope" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.MetricsAdvisor.Models.DimensionKey</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Defines the set of time series included in this scope. If all possible dimensions are set, the
            key uniquely identifies a single time series for the corresponding metric. If only a subset of
            dimensions are set, the key uniquely identifies a group of time series.
            </summary>
        <value>To be added.</value>
        <remarks>
            This property is only set when <see cref="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.ScopeType" /> is <see cref="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScopeType.SeriesGroup" />.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="TopNGroupInScope">
      <MemberSignature Language="C#" Value="public Azure.AI.MetricsAdvisor.Models.TopNGroupScope TopNGroupInScope { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Azure.AI.MetricsAdvisor.Models.TopNGroupScope TopNGroupInScope" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.TopNGroupInScope" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TopNGroupInScope As TopNGroupScope" />
      <MemberSignature Language="F#" Value="member this.TopNGroupInScope : Azure.AI.MetricsAdvisor.Models.TopNGroupScope" Usage="Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.TopNGroupInScope" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.MetricsAdvisor.Models.TopNGroupScope</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Defines the top N series included in this scope.
            </summary>
        <value>To be added.</value>
        <remarks>
            This property is only set when <see cref="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScope.ScopeType" /> is <see cref="P:Azure.AI.MetricsAdvisor.Models.MetricAnomalyAlertScopeType.TopN" />.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>