Skip to content

Commit

Permalink
Monitor Query SDK README/samples updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@scottaddie
scottaddie committed Jun 30, 2021
1 parent a3af338 commit a184d97
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 12 deletions.
32 changes: 24 additions & 8 deletions sdk/monitor/Azure.Monitor.Query/src/LogsQueryClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,16 @@ protected LogsQueryClient()
///
/// Example of querying a model:
/// <code snippet="Snippet:QueryLogsAsModelCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
/// </code>
///
/// Example of querying a primitive:
/// <code snippet="Snippet:QueryLogsAsPrimitiveCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count | project ResourceGroup&quot;,
/// TimeSpan.FromDays(1));
/// </code>
Expand All @@ -113,14 +115,16 @@ public virtual Response<IReadOnlyList<T>> Query<T>(string workspaceId, string qu
///
/// Example of querying a model:
/// <code snippet="Snippet:QueryLogsAsModelCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
/// </code>
///
/// Example of querying a primitive:
/// <code snippet="Snippet:QueryLogsAsPrimitiveCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count | project ResourceGroup&quot;,
/// TimeSpan.FromDays(1));
/// </code>
Expand Down Expand Up @@ -198,8 +202,14 @@ public virtual async Task<Response<LogsQueryResult>> QueryAsync(string workspace
/// // And total event count
/// var batch = new LogsBatchQuery();
///
/// string countQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | count&quot;, TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;, TimeSpan.FromDays(1));
/// string countQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | count&quot;,
/// TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
///
/// Response&lt;LogsBatchQueryResults&gt; response = await client.QueryBatchAsync(batch);
///
Expand Down Expand Up @@ -246,8 +256,14 @@ public virtual Response<LogsBatchQueryResults> QueryBatch(LogsBatchQuery batch,
/// // And total event count
/// var batch = new LogsBatchQuery();
///
/// string countQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | count&quot;, TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;, TimeSpan.FromDays(1));
/// string countQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | count&quot;,
/// TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
///
/// Response&lt;LogsBatchQueryResults&gt; response = await client.QueryBatchAsync(batch);
///
Expand Down
10 changes: 8 additions & 2 deletions sdk/monitor/Azure.Monitor.Query/src/Models/LogsBatchQuery.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,14 @@ public LogsBatchQuery()
/// <summary>
/// Adds the specified query to the batch. Results can be retrieved after the query is submitted via the <see cref="LogsQueryClient.QueryBatchAsync"/> call.
/// <code snippet="Snippet:BatchQueryAddAndGet" language="csharp">
/// string countQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | count&quot;, TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;, TimeSpan.FromDays(1));
/// string countQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | count&quot;,
/// TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
///
/// Response&lt;LogsBatchQueryResults&gt; response = await client.QueryBatchAsync(batch);
///
Expand Down
10 changes: 8 additions & 2 deletions sdk/monitor/Azure.Monitor.Query/src/Models/LogsBatchQueryResults.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,14 @@ public partial class LogsBatchQueryResults
/// Gets the result for the query that was a part of the batch.
/// </summary>
/// <code snippet="Snippet:BatchQueryAddAndGet" language="csharp">
/// string countQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | count&quot;, TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;, TimeSpan.FromDays(1));
/// string countQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | count&quot;,
/// TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
///
/// Response&lt;LogsBatchQueryResults&gt; response = await client.QueryBatchAsync(batch);
///
Expand Down

0 comments on commit a184d97

Please sign in to comment.