TelemetryClientExtensions.xml

<Type Name="TelemetryClientExtensions" FullName="Microsoft.ApplicationInsights.Metrics.Extensibility.TelemetryClientExtensions">
  <TypeSignature Language="C#" Value="public static class TelemetryClientExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit TelemetryClientExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ApplicationInsights.Metrics.Extensibility.TelemetryClientExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module TelemetryClientExtensions" />
  <TypeSignature Language="F#" Value="type TelemetryClientExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ApplicationInsights</AssemblyName>
    <AssemblyVersion>2.17.0.146</AssemblyVersion>
    <AssemblyVersion>2.18.0.315</AssemblyVersion>
    <AssemblyVersion>2.19.0.227</AssemblyVersion>
    <AssemblyVersion>2.20.0.103</AssemblyVersion>
    <AssemblyVersion>2.21.0.429</AssemblyVersion>
    <AssemblyVersion>2.22.0.405</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Metric related extension methods for the <c>TelemetryClient</c>.
            Note that these APIs are in the ...Extensibility namespace and do not pollute the API surfact for users who do not import it.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="GetMetricManager">
      <MemberSignature Language="C#" Value="public static Microsoft.ApplicationInsights.Metrics.MetricManager GetMetricManager (this Microsoft.ApplicationInsights.TelemetryClient telemetryClient, Microsoft.ApplicationInsights.MetricAggregationScope aggregationScope);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ApplicationInsights.Metrics.MetricManager GetMetricManager(class Microsoft.ApplicationInsights.TelemetryClient telemetryClient, valuetype Microsoft.ApplicationInsights.MetricAggregationScope aggregationScope) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ApplicationInsights.Metrics.Extensibility.TelemetryClientExtensions.GetMetricManager(Microsoft.ApplicationInsights.TelemetryClient,Microsoft.ApplicationInsights.MetricAggregationScope)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function GetMetricManager (telemetryClient As TelemetryClient, aggregationScope As MetricAggregationScope) As MetricManager" />
      <MemberSignature Language="F#" Value="static member GetMetricManager : Microsoft.ApplicationInsights.TelemetryClient * Microsoft.ApplicationInsights.MetricAggregationScope -&gt; Microsoft.ApplicationInsights.Metrics.MetricManager" Usage="Microsoft.ApplicationInsights.Metrics.Extensibility.TelemetryClientExtensions.GetMetricManager (telemetryClient, aggregationScope)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ApplicationInsights</AssemblyName>
        <AssemblyVersion>2.21.0.429</AssemblyVersion>
        <AssemblyVersion>2.22.0.405</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ApplicationInsights.Metrics.MetricManager</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="telemetryClient" Type="Microsoft.ApplicationInsights.TelemetryClient" RefType="this" />
        <Parameter Name="aggregationScope" Type="Microsoft.ApplicationInsights.MetricAggregationScope" />
      </Parameters>
      <Docs>
        <param name="telemetryClient">The telemetry client for which to get the metric manager.</param>
        <param name="aggregationScope">If <c>MetricAggregationScope.TelemetryClient</c> is specified,
            the metric manager specific to this client is returned. Such manager aggregates metrics for this
            client object only. Two metrics with exactly the same id, namespace and dimensions would be aggregated
            separately for different telemetry client objects when this scope is used.<br />
            If <c>MetricAggregationScope.TelemetryConfiguration</c> is specified,
            the metric manager for the telemetry configuration of this client is returned. Such manager aggregates
            metrics for all clients that use that telemetry configuration. Two metrics with exactly the same id,
            namespace and dimensions would be aggregated together for different telemetry client objects that use
            the same telemetry configuration when this scope is used. <br /><seealso cref="T:Microsoft.ApplicationInsights.MetricAggregationScope" /></param>
        <summary>Gets the <c>MetricManager</c> for this <c>TelemetryClient</c> at the specified scope.
            If a metric manager does not exist at the specified scope, it is created.</summary>
        <returns>The metric manager for this telemetry client at the specified scope.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>