[monitor] query resource (Azure#20570)

* added queryresource

* update autorest version

* update autorest.md

* test

* test example

* documentation

Co-authored-by: Charles Lowell <10964656+chlowell@users.noreply.github.com>

---------

Co-authored-by: Charles Lowell <10964656+chlowell@users.noreply.github.com>

Author: gracewilcox

eng/config.json

@@ -83,7 +83,7 @@
         },
         {
             "Name": "monitor/azquery",
-            "CoverageGoal": 0.80
+            "CoverageGoal": 0.85
         },
         {
             "Name": "resourcemanager",

sdk/monitor/azquery/CHANGELOG.md

@@ -1,14 +1,12 @@
 # Release History
 
-## 1.0.1 (Unreleased)
+## 1.1.0-beta.1 (2023-04-11)
 
 ### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
+* Added the `LogsClient.QueryResource` method which allow users to query Azure resources directly without a Log Analytics workspace
 
 ### Other Changes
+* Updated dependencies and documentation
 
 ## 1.0.0 (2023-02-08)
 

sdk/monitor/azquery/README.md

@@ -13,8 +13,8 @@ The Azure Monitor Query client module is used to execute read-only queries again
 
 * Go, version 1.18 or higher - [Install Go](https://go.dev/doc/install)
 * Azure subscription - [Create a free account][azure_sub]
-* To query logs, an Azure Log Analytics workspace ID - Create an [Azure Log Analytics workspace][log_analytics_workspace_create]
-* To query metrics, the Resource URI of an Azure resource (Storage Account, Key Vault, CosmosDB, etc.) that you plan to monitor
+* To query some logs, an Azure Log Analytics workspace ID - Create an [Azure Log Analytics workspace][log_analytics_workspace_create]
+* To query metrics and some logs, the Resource URI of an Azure resource (Storage Account, Key Vault, CosmosDB, etc.) that you plan to monitor
 
 ### Install the packages
 
@@ -100,7 +100,7 @@ To do the same with `QueryBatch`, set the values in the `BatchQueryRequest.Heade
 
 Get started with our [examples][azquery_pkg_go_samples].
 
-* For the majority of log queries, use the `LogsClient.QueryWorkspace` method. Only use the `LogsClient.QueryBatch` method in advanced scenerios.
+* For the majority of log queries, use the `LogsClient.QueryWorkspace` or the `LogsClient.QueryResource` method. Only use the `LogsClient.QueryBatch` method in advanced scenerios.
 
 * Use `MetricsClient.QueryResource` for metric queries.
 

sdk/monitor/azquery/TROUBLESHOOTING.md

@@ -85,15 +85,17 @@ The error message in `innererror` may include the location where the Kusto query
 
 ### Troubleshooting empty log query results
 
-If your Kusto query returns empty no logs, please validate the following:
+If your Kusto query returns empty with no logs, please validate the following:
 
-- You have the right workspace ID
+- You have the right workspace ID or resource ID
 - You are setting the correct time interval for the query. Try lengthening the time interval for your query to see if that
   returns any results.
 - If your Kusto query also has a time interval, the query is evaluated for the intersection of the time interval in the
   query string and the time interval set in the `Body.Timespan` field of the request query. The intersection of
   these time intervals may not have any logs. To avoid any confusion, it's recommended to remove any time interval in
   the Kusto query string and use `Body.Timespan` explicitly.
+- Your workspace or resource actually has logs to query. Sometimes, especially with newly created resources,
+  there are no logs yet to query.
 
 ### Troubleshooting server timeouts when executing logs query request
 

sdk/monitor/azquery/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "go",
   "TagPrefix": "go/monitor/azquery",
-  "Tag": "go/monitor/azquery_123118d585"
+  "Tag": "go/monitor/azquery_4e1ec7fc44"
 }

sdk/monitor/azquery/autorest.md

@@ -9,7 +9,7 @@ clear-output-folder: false
 export-clients: true
 go: true
 input-file: 
-    - https://github.com/Azure/azure-rest-api-specs/blob/dba6ed1f03bda88ac6884c0a883246446cc72495/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json
+    - https://github.com/Azure/azure-rest-api-specs/blob/605407bc0c1a133018285f550d01175469cb3c3a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json
     - https://github.com/Azure/azure-rest-api-specs/blob/dba6ed1f03bda88ac6884c0a883246446cc72495/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json
     - https://github.com/Azure/azure-rest-api-specs/blob/dba6ed1f03bda88ac6884c0a883246446cc72495/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json
     - https://github.com/Azure/azure-rest-api-specs/blob/dba6ed1f03bda88ac6884c0a883246446cc72495/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json
@@ -19,20 +19,27 @@ openapi-type: "data-plane"
 output-folder: ../azquery
 override-client-name: LogsClient
 security: "AADToken"
-use: "@autorest/go@4.0.0-preview.44"
+use: "@autorest/go@4.0.0-preview.46"
 version: "^3.0.0"
 
 directive:
-  # delete metadata endpoint
+  # delete extra endpoints
   - from: swagger-document
     where: $["paths"]
     transform: >
         delete $["/workspaces/{workspaceId}/metadata"];
+  - from: swagger-document
+    where: $["x-ms-paths"]
+    transform: >
+        delete $["/{resourceId}/query?disambiguation_dummy"];
 
-  # delete metadata operations
+  # delete extra operations
   - remove-operation: Metadata_Post
   - remove-operation: Metadata_Get
   - remove-operation: Query_Get
+  - remove-operation: Query_ResourceGet
+  - remove-operation: Query_ResourceExecuteXms
+  - remove-operation: Query_ResourceGetXms
 
   # delete metadata models
   - remove-model: metadataResults
@@ -47,20 +54,19 @@ directive:
   - remove-model: metadataResource
   - remove-model: metadataPermissions
 
- # rename log queries
+ # rename operations to generate into metrics and logs clients
   - rename-operation:
       from: Query_Execute
       to: Logs_QueryWorkspace
   - rename-operation:
       from: Query_Batch
       to: Logs_QueryBatch
-
-  # rename metric list to QueryResource
+  - rename-operation:
+      from: Query_ResourceExecute
+      to: Logs_QueryResource
   - rename-operation:
       from: Metrics_List
       to: Metrics_QueryResource
-
- # rename ListMetricDefinitions and ListMetricNamespaces to generate in metrics_client.go
   - rename-operation:
       from: MetricDefinitions_List
       to: Metrics_ListDefinitions
@@ -123,7 +129,7 @@ directive:
     transform: return $.replace(/Options \*string/g, "Options *LogsQueryOptions");
   - from: logs_client.go
     where: $
-    transform: return $.replace(/\*options\.Options/, "options.Options.preferHeader()");
+    transform: return $.replace(/\*options\.Options/g, "options.Options.preferHeader()");
 
   # add default values for batch request path and method attributes
   - from: swagger-document
@@ -132,6 +138,18 @@ directive:
   - from: swagger-document
     where: $.definitions.batchQueryRequest.properties.method
     transform: $["x-ms-client-default"] = "POST"
+  - from: swagger-document
+    where: $.definitions.batchQueryRequest.properties.path.x-ms-enum
+    transform: $["modelAsString"] = true
+  - from: swagger-document
+    where: $.definitions.batchQueryRequest.properties.path.x-ms-enum
+    transform: $["name"] = "BatchQueryRequestPath"
+  - from: swagger-document
+    where: $.definitions.batchQueryRequest.properties.method.x-ms-enum
+    transform: $["modelAsString"] = true
+  - from: swagger-document
+    where: $.definitions.batchQueryRequest.properties.method.x-ms-enum
+    transform: $["name"] = "BatchQueryRequestMethod"
 
   # add descriptions for models and constants that don't have them
   - from: swagger-document
@@ -179,38 +197,22 @@ directive:
   # delete unused error models
   - from: models.go
     where: $
-    transform: return $.replace(/(?:\/\/.*\s)+type (?:ErrorResponse|ErrorResponseAutoGenerated).+\{(?:\s.+\s)+\}\s/g, "");
-  - from: models_serde.go
-    where: $
-    transform: return $.replace(/(?:\/\/.*\s)+func \(\w \*?(?:ErrorResponse|ErrorResponseAutoGenerated)\).*\{\s(?:.+\s)+\}\s/g, "");
-  - from: models.go
-    where: $
-    transform: return $.replace(/(?:\/\/.*\s)+type (?:ErrorInfo|ErrorDetail).+\{(?:\s.+\s)+\}\s/g, "");
+    transform: return $.replace(/(?:\/\/.*\s)+type (?:ErrorResponse|ErrorResponseAutoGenerated|ErrorInfo|ErrorDetail).+\{(?:\s.+\s)+\}\s/g, "");
   - from: models_serde.go
     where: $
-    transform: return $.replace(/(?:\/\/.*\s)+func \(\w \*?(?:ErrorInfo|ErrorDetail)\).*\{\s(?:.+\s)+\}\s/g, "");
-
-  # delete generated constructor and client
-  - from: logs_client.go
-    where: $
-    transform: return $.replace(/(?:\/\/.*\s)+func NewLogsClient.+\{\s(?:.+\s)+\}\s/, "");
-  - from: logs_client.go
-    where: $
-    transform: return $.replace(/(?:\/\/.*\s)+type LogsClient struct.+\{\s(?:.+\s)+\}\s/, "");
-  - from: metrics_client.go
-    where: $
-    transform: return $.replace(/(?:\/\/.*\s)+func NewMetricsClient.+\{\s(?:.+\s)+\}\s/, "");
-  - from: metrics_client.go
-    where: $
-    transform: return $.replace(/(?:\/\/.*\s)+type MetricsClient.+\{\s(?:.+\s)+\}\s/, "");
+    transform: return $.replace(/(?:\/\/.*\s)+func \(\w \*?(?:ErrorResponse|ErrorResponseAutoGenerated|ErrorInfo|ErrorDetail)\).*\{\s(?:.+\s)+\}\s/g, "");
 
   # point the clients to the correct host url
-  - from: logs_client.go
+  - from: 
+         - logs_client.go
+         - metrics_client.go
     where: $
     transform: return $.replace(/host/g, "client.host");
-  - from: metrics_client.go
+  - from: 
+         - logs_client.go
+         - metrics_client.go
     where: $
-    transform: return $.replace(/host/g, "client.host");
+    transform: return $.replace(/internal \*azcore.Client/g, "host string\n internal *azcore.Client");
 
   # delete generated host url
   - from: constants.go
@@ -220,15 +222,15 @@ directive:
   # change Table.Rows from type [][]interface{} to type []Row
   - from: models.go
     where: $
-    transform: return $.replace(/Rows \[\]\[\]interface{}/, "Rows []Row");
+    transform: return $.replace(/Rows \[\]\[\]any/, "Rows []Row");
 
   # change render and statistics type to []byte
   - from: models.go
     where: $
-    transform: return $.replace(/Statistics interface{}/g, "Statistics []byte");
+    transform: return $.replace(/Statistics any/g, "Statistics []byte");
   - from: models.go
     where: $
-    transform: return $.replace(/Visualization interface{}/g, "Visualization []byte");
+    transform: return $.replace(/Visualization any/g, "Visualization []byte");
   - from: models_serde.go
     where: $
     transform: return 

sdk/monitor/azquery/custom_client.go

@@ -32,20 +32,6 @@ type LogsClientOptions struct {
 	azcore.ClientOptions
 }
 
-// LogsClient contains the methods for the LogsClient group.
-// Don't use this type directly, use NewLogsClient() instead.
-type LogsClient struct {
-	host string
-	pl   runtime.Pipeline
-}
-
-// MetricsClient contains the methods for the Metrics group.
-// Don't use this type directly, use NewMetricsClient() instead.
-type MetricsClient struct {
-	host string
-	pl   runtime.Pipeline
-}
-
 // NewLogsClient creates a client that accesses Azure Monitor logs data.
 func NewLogsClient(credential azcore.TokenCredential, options *LogsClientOptions) (*LogsClient, error) {
 	if options == nil {
@@ -60,8 +46,11 @@ func NewLogsClient(credential azcore.TokenCredential, options *LogsClientOptions
 	}
 
 	authPolicy := runtime.NewBearerTokenPolicy(credential, []string{c.Audience + "/.default"}, nil)
-	pl := runtime.NewPipeline(moduleName, version, runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}, &options.ClientOptions)
-	return &LogsClient{host: c.Endpoint, pl: pl}, nil
+	azcoreClient, err := azcore.NewClient("azquery.LogsClient", version, runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}, &options.ClientOptions)
+	if err != nil {
+		return nil, err
+	}
+	return &LogsClient{host: c.Endpoint, internal: azcoreClient}, nil
 }
 
 // NewMetricsClient creates a client that accesses Azure Monitor metrics data.
@@ -78,8 +67,11 @@ func NewMetricsClient(credential azcore.TokenCredential, options *MetricsClientO
 	}
 
 	authPolicy := runtime.NewBearerTokenPolicy(credential, []string{c.Audience + "/.default"}, nil)
-	pl := runtime.NewPipeline(moduleName, version, runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}, &options.ClientOptions)
-	return &MetricsClient{host: c.Endpoint, pl: pl}, nil
+	azcoreClient, err := azcore.NewClient("azquery.MetricsClient", version, runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}, &options.ClientOptions)
+	if err != nil {
+		return nil, err
+	}
+	return &MetricsClient{host: c.Endpoint, internal: azcoreClient}, nil
 }
 
 // ErrorInfo - The code and message for an error.

sdk/monitor/azquery/example_test.go

@@ -62,6 +62,7 @@ func ExampleLogsClient_QueryWorkspace() {
 	// 1. If not already made, create a Log Analytics workspace (https://learn.microsoft.com/azure/azure-monitor/logs/quick-create-workspace).
 	// 2. Navigate to your workspace's page in the Azure portal.
 	// 3. From the **Overview** blade, copy the value of the ***Workspace ID*** property.
+
 	workspaceID := "g4d1e129-fb1e-4b0a-b234-250abc987ea65" // example Azure Log Analytics Workspace ID
 
 	res, err := logsClient.QueryWorkspace(
@@ -150,6 +151,40 @@ func ExampleLogsClient_QueryWorkspace_second() {
 
 }
 
+func ExampleLogsClient_QueryResource() {
+	// Instead of requiring a Log Analytics workspace,
+	// QueryResource allows users to query logs directly from an Azure resource through a resource ID.
+
+	// To find the resource ID:
+	// 1. Navigate to your resource's page in the Azure portal.
+	// 2. From the **Overview** blade, select the **JSON View** link.
+	// 3. In the resulting JSON, copy the value of the `id` property.
+
+	resourceID := "/subscriptions/fajfkx93-c1d8-40ad-9cce-e49c10ca8qe6/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/mystorageacount" // example resource ID
+
+	res, err := logsClient.QueryResource(
+		context.TODO(),
+		resourceID,
+		azquery.Body{
+			Query:    to.Ptr("StorageBlobLogs | where TimeGenerated > ago(3d)"), // example Kusto query
+			Timespan: to.Ptr(azquery.NewTimeInterval(time.Date(2022, 12, 25, 0, 0, 0, 0, time.UTC), time.Date(2022, 12, 25, 12, 0, 0, 0, time.UTC))),
+		},
+		nil)
+	if err != nil {
+		//TODO: handle error
+	}
+	if res.Error != nil {
+		//TODO: handle partial error
+	}
+
+	// Print Rows
+	for _, table := range res.Tables {
+		for _, row := range table.Rows {
+			fmt.Println(row)
+		}
+	}
+}
+
 func ExampleLogsClient_QueryBatch() {
 	// `QueryBatch` is an advanced method allowing users to execute multiple log queries in a single request.
 	// For help formatting a `BatchRequest`, please use the method `NewBatchQueryRequest`.