DatabaseOperationsExtensions.xml

<Type Name="DatabaseOperationsExtensions" FullName="Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions">
  <TypeSignature Language="C#" Value="public static class DatabaseOperationsExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DatabaseOperationsExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module DatabaseOperationsExtensions" />
  <TypeSignature Language="F#" Value="type DatabaseOperationsExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
    <AssemblyVersion>1.0.0.71</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Extension methods for DatabaseOperations.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="ListMetricDefinitionsAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.MetricDefinition&gt;&gt; ListMetricDefinitionsAsync (this Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Management.CosmosDB.Fluent.Models.MetricDefinition&gt;&gt; ListMetricDefinitionsAsync(class Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions.ListMetricDefinitionsAsync(Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations,System.String,System.String,System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ListMetricDefinitionsAsync (operations As IDatabaseOperations, resourceGroupName As String, accountName As String, databaseRid As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of MetricDefinition))" />
      <MemberSignature Language="F#" Value="static member ListMetricDefinitionsAsync : Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations * string * string * string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;seq&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.MetricDefinition&gt;&gt;" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions.ListMetricDefinitionsAsync (operations, resourceGroupName, accountName, databaseRid, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
        <AssemblyVersion>1.0.0.71</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.MetricDefinition&gt;&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="operations" Type="Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations" RefType="this" />
        <Parameter Name="resourceGroupName" Type="System.String" />
        <Parameter Name="accountName" Type="System.String" />
        <Parameter Name="databaseRid" Type="System.String" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="operations">
            The operations group for this extension method.
            </param>
        <param name="resourceGroupName">
            Name of an Azure resource group.
            </param>
        <param name="accountName">
            Cosmos DB database account name.
            </param>
        <param name="databaseRid">
            Cosmos DB database rid.
            </param>
        <param name="cancellationToken">
            The cancellation token.
            </param>
        <summary>
            Retrieves metric definitions for the given database.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ListMetricsAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.Metric&gt;&gt; ListMetricsAsync (this Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, string filter, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Management.CosmosDB.Fluent.Models.Metric&gt;&gt; ListMetricsAsync(class Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions.ListMetricsAsync(Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations,System.String,System.String,System.String,System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ListMetricsAsync (operations As IDatabaseOperations, resourceGroupName As String, accountName As String, databaseRid As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of Metric))" />
      <MemberSignature Language="F#" Value="static member ListMetricsAsync : Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations * string * string * string * string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;seq&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.Metric&gt;&gt;" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions.ListMetricsAsync (operations, resourceGroupName, accountName, databaseRid, filter, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
        <AssemblyVersion>1.0.0.71</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.Metric&gt;&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="operations" Type="Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations" RefType="this" />
        <Parameter Name="resourceGroupName" Type="System.String" />
        <Parameter Name="accountName" Type="System.String" />
        <Parameter Name="databaseRid" Type="System.String" />
        <Parameter Name="filter" Type="System.String" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="operations">
            The operations group for this extension method.
            </param>
        <param name="resourceGroupName">
            Name of an Azure resource group.
            </param>
        <param name="accountName">
            Cosmos DB database account name.
            </param>
        <param name="databaseRid">
            Cosmos DB database rid.
            </param>
        <param name="filter">
            An OData filter expression that describes a subset of metrics to return.
            The parameters that can be filtered are name.value (name of the metric, can
            have an or of multiple names), startTime, endTime, and timeGrain. The
            supported operator is eq.
            </param>
        <param name="cancellationToken">
            The cancellation token.
            </param>
        <summary>
            Retrieves the metrics determined by the given filter for the given database
            account and database.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ListUsagesAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.Usage&gt;&gt; ListUsagesAsync (this Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, string filter = default, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Management.CosmosDB.Fluent.Models.Usage&gt;&gt; ListUsagesAsync(class Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions.ListUsagesAsync(Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations,System.String,System.String,System.String,System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ListUsagesAsync (operations As IDatabaseOperations, resourceGroupName As String, accountName As String, databaseRid As String, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of Usage))" />
      <MemberSignature Language="F#" Value="static member ListUsagesAsync : Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations * string * string * string * string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;seq&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.Usage&gt;&gt;" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.DatabaseOperationsExtensions.ListUsagesAsync (operations, resourceGroupName, accountName, databaseRid, filter, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
        <AssemblyVersion>1.0.0.71</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Management.CosmosDB.Fluent.Models.Usage&gt;&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="operations" Type="Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseOperations" RefType="this" />
        <Parameter Name="resourceGroupName" Type="System.String" />
        <Parameter Name="accountName" Type="System.String" />
        <Parameter Name="databaseRid" Type="System.String" />
        <Parameter Name="filter" Type="System.String" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="operations">
            The operations group for this extension method.
            </param>
        <param name="resourceGroupName">
            Name of an Azure resource group.
            </param>
        <param name="accountName">
            Cosmos DB database account name.
            </param>
        <param name="databaseRid">
            Cosmos DB database rid.
            </param>
        <param name="filter">
            An OData filter expression that describes a subset of usages to return. The
            supported parameter is name.value (name of the metric, can have an or of
            multiple names).
            </param>
        <param name="cancellationToken">
            The cancellation token.
            </param>
        <summary>
            Retrieves the usages (most recent data) for the given database.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>