-
Notifications
You must be signed in to change notification settings - Fork 256
/
LogsBatchQueryResultCollection.xml
109 lines (107 loc) · 6.88 KB
/
LogsBatchQueryResultCollection.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<Type Name="LogsBatchQueryResultCollection" FullName="Azure.Monitor.Query.Models.LogsBatchQueryResultCollection">
<TypeSignature Language="C#" Value="public class LogsBatchQueryResultCollection : System.Collections.ObjectModel.ReadOnlyCollection<Azure.Monitor.Query.Models.LogsBatchQueryResult>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LogsBatchQueryResultCollection extends System.Collections.ObjectModel.ReadOnlyCollection`1<class Azure.Monitor.Query.Models.LogsBatchQueryResult>" />
<TypeSignature Language="DocId" Value="T:Azure.Monitor.Query.Models.LogsBatchQueryResultCollection" />
<TypeSignature Language="VB.NET" Value="Public Class LogsBatchQueryResultCollection
Inherits ReadOnlyCollection(Of LogsBatchQueryResult)" />
<TypeSignature Language="F#" Value="type LogsBatchQueryResultCollection = class
 inherit ReadOnlyCollection<LogsBatchQueryResult>" />
<AssemblyInfo>
<AssemblyName>Azure.Monitor.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Collections.ObjectModel.ReadOnlyCollection<Azure.Monitor.Query.Models.LogsBatchQueryResult></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="!0">Azure.Monitor.Query.Models.LogsBatchQueryResult</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a collection of results returned from a batch query.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetResult">
<MemberSignature Language="C#" Value="public Azure.Monitor.Query.Models.LogsBatchQueryResult GetResult (string queryId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.Monitor.Query.Models.LogsBatchQueryResult GetResult(string queryId) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Monitor.Query.Models.LogsBatchQueryResultCollection.GetResult(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetResult (queryId As String) As LogsBatchQueryResult" />
<MemberSignature Language="F#" Value="member this.GetResult : string -> Azure.Monitor.Query.Models.LogsBatchQueryResult" Usage="logsBatchQueryResultCollection.GetResult queryId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Monitor.Query</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Monitor.Query.Models.LogsBatchQueryResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="queryId" Type="System.String" />
</Parameters>
<Docs>
<param name="queryId">The query identifier returned from the <see cref="M:Azure.Monitor.Query.LogsBatchQuery.AddWorkspaceQuery(System.String,System.String,Azure.Monitor.Query.QueryTimeRange,Azure.Monitor.Query.LogsQueryOptions)" />.</param>
<summary>
Gets the result for the query that was a part of the batch.
</summary>
<returns>The <see cref="T:Azure.Monitor.Query.Models.LogsBatchQueryResultCollection" /> with the query results.</returns>
<remarks>To be added.</remarks>
<code snippet="Snippet:BatchQueryAddAndGet" language="csharp">
string countQueryId = batch.AddWorkspaceQuery(
workspaceId,
"AzureActivity | count",
new QueryTimeRange(TimeSpan.FromDays(1)));
string topQueryId = batch.AddWorkspaceQuery(
workspaceId,
"AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count",
new QueryTimeRange(TimeSpan.FromDays(1)));
Response<LogsBatchQueryResultCollection> response = await client.QueryBatchAsync(batch);
var count = response.Value.GetResult<int>(countQueryId).Single();
var topEntries = response.Value.GetResult<MyLogEntryModel>(topQueryId);
</code>
<exception cref="T:System.ArgumentException">When the query with <paramref name="queryId" /> was not part of the batch.</exception>
<exception cref="T:Azure.RequestFailedException">When the query <paramref name="queryId" /> failed.</exception>
</Docs>
</Member>
<Member MemberName="GetResult<T>">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<T> GetResult<T> (string queryId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IReadOnlyList`1<!!T> GetResult<T>(string queryId) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Monitor.Query.Models.LogsBatchQueryResultCollection.GetResult``1(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetResult(Of T) (queryId As String) As IReadOnlyList(Of T)" />
<MemberSignature Language="F#" Value="member this.GetResult : string -> System.Collections.Generic.IReadOnlyList<'T>" Usage="logsBatchQueryResultCollection.GetResult queryId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Monitor.Query</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="queryId" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="queryId">The query identifier returned from the <see cref="M:Azure.Monitor.Query.LogsBatchQuery.AddWorkspaceQuery(System.String,System.String,Azure.Monitor.Query.QueryTimeRange,Azure.Monitor.Query.LogsQueryOptions)" />.</param>
<summary>
Gets the result for the query that was a part of the batch.
</summary>
<returns>Query results mapped to a type <typeparamref name="T" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">When the query with <paramref name="queryId" /> was not part of the batch.</exception>
<exception cref="T:Azure.RequestFailedException">When the query <paramref name="queryId" /> failed.</exception>
</Docs>
</Member>
</Members>
</Type>