Azure Monitor Query

https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery
Admin
Azure Monitor Query (azquery) is a Go client module used to execute read-only queries against Azure...
Tokens:7,999
Snippets:98
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install azquery and azidentity modules

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Use go get to install the necessary Azure SDK modules for querying and authentication.

```bash
go get github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery
go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
```

--------------------------------

### Initialize LogsClient

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Constructor for creating a new LogsClient instance using credentials and options.

```go
func NewLogsClient(credential azcore.TokenCredential, options *LogsClientOptions) (*LogsClient, error)
```

--------------------------------

### Logs Client Options

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional settings for the LogsClient.

```go
type LogsClientOptions struct {
	azcore.ClientOptions
}
```

--------------------------------

### Logs Query Options

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Configuration for server timeout, query statistics, and visualization.

```go
type LogsQueryOptions struct {
	// Set Statistics to true to get logs query execution statistics,
	// such as CPU and memory consumption. Defaults to false.
	Statistics *bool

	// Set Visualization to true to get visualization
	// data for logs queries. Defaults to false.
	Visualization *bool

	// By default, the Azure Monitor Query service will run your
	// query for up to three minutes. To increase the default timeout,
	// set Wait to desired number of seconds.
	// Max wait time the service will allow is ten minutes (600 seconds).
	Wait *int
}
```

--------------------------------

### Create a Batch Query Request

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Initializes a new BatchQueryRequest instance.

```go
func NewBatchQueryRequest(workspaceID string, query string, timespan TimeInterval, correlationID string, options LogsQueryOptions) BatchQueryRequest
```

--------------------------------

### NewMetricsClient Constructor

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Creates a client for accessing Azure Monitor metrics data.

```go
func NewMetricsClient(credential azcore.TokenCredential, options *MetricsClientOptions) (*MetricsClient, error)
```

--------------------------------

### Logs Client Query Workspace Options

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional parameters for the QueryWorkspace method.

```go
type LogsClientQueryWorkspaceOptions struct {
	// Optional. The prefer header to set server timeout, query statistics and visualization information.
	Options *LogsQueryOptions
}
```

--------------------------------

### Logs Client Query Resource Options

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional parameters for the QueryResource method.

```go
type LogsClientQueryResourceOptions struct {
	// Optional. The prefer header to set server timeout, query statistics and visualization information.
	Options *LogsQueryOptions
}
```

--------------------------------

### Logs Client Query Batch Options

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional parameters for the QueryBatch method.

```go
type LogsClientQueryBatchOptions struct {
}
```

--------------------------------

### QueryResource Method

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Lists the metric values for a resource. Returns an *azcore.ResponseError on failure.

```go
func (client *MetricsClient) QueryResource(ctx context.Context, resourceURI string, options *MetricsClientQueryResourceOptions) (MetricsClientQueryResourceResponse, error)
```

--------------------------------

### MetricsClientOptions Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional settings for the MetricsClient.

```go
type MetricsClientOptions struct {
	azcore.ClientOptions
}
```

--------------------------------

### Configure Advanced Logs Query Options

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Use the LogsClientQueryWorkspaceOptions struct to enable statistics, visualization, and increase the query timeout up to 600 seconds.

```go
azquery.LogsClientQueryWorkspaceOptions{
			Options: &azquery.LogsQueryOptions{
				Statistics:    to.Ptr(true),
				Visualization: to.Ptr(true),
				Wait:          to.Ptr(600),
			},
		}
```

--------------------------------

### MetricUnit Constants and Helper

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the supported units for metrics and provides a function to retrieve all possible values.

```go
type MetricUnit string
```

```go
const (
	// MetricUnitBitsPerSecond - Rate unit of binary digits per second.
	MetricUnitBitsPerSecond MetricUnit = "BitsPerSecond"
	// MetricUnitByteSeconds - Unit of data transfer or storage. It is the size of the data in bytes multiplied by the time it
	// takes to transfer or store the data in seconds.
	MetricUnitByteSeconds MetricUnit = "ByteSeconds"
	// MetricUnitBytes - Unit of memory in bytes.
	MetricUnitBytes MetricUnit = "Bytes"
	// MetricUnitBytesPerSecond - Rate unit of memory in bytes per second.
	MetricUnitBytesPerSecond MetricUnit = "BytesPerSecond"
	// MetricUnitCores - Unit of processing power.
	MetricUnitCores MetricUnit = "Cores"
	// MetricUnitCount - Unit of raw quantity.
	MetricUnitCount MetricUnit = "Count"
	// MetricUnitCountPerSecond - Rate unit of raw quantity per second.
	MetricUnitCountPerSecond MetricUnit = "CountPerSecond"
	// MetricUnitMilliCores - Unit of processing power in 1/1000th of a CPU core.
	MetricUnitMilliCores MetricUnit = "MilliCores"
	// MetricUnitMilliSeconds - Unit of time in 1/1000th of a second.
	MetricUnitMilliSeconds MetricUnit = "MilliSeconds"
	// MetricUnitNanoCores - Unit of processing power in one billionth of a CPU core.
	MetricUnitNanoCores MetricUnit = "NanoCores"
	// MetricUnitPercent - Percentage unit.
	MetricUnitPercent MetricUnit = "Percent"
	// MetricUnitSeconds - Unit of time in seconds.
	MetricUnitSeconds MetricUnit = "Seconds"
	// MetricUnitUnspecified - No specified unit.
	MetricUnitUnspecified MetricUnit = "Unspecified"
)
```

```go
func PossibleMetricUnitValues() []MetricUnit
```

--------------------------------

### TimeInterval Management

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Utilities for creating and parsing ISO8601 time intervals for query ranges.

```go
type TimeInterval string
```

```go
func NewTimeInterval(start time.Time, end time.Time) TimeInterval
```

```go
func (i TimeInterval) Values() (time.Time, time.Time, error)
```

--------------------------------

### NewLogsClient

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Creates a new client instance to access Azure Monitor logs data using provided credentials and options.

```APIDOC
## func NewLogsClient

### Description
Creates a client that accesses Azure Monitor logs data.

### Signature
`func NewLogsClient(credential azcore.TokenCredential, options *LogsClientOptions) (*LogsClient, error)`
```

--------------------------------

### NewListDefinitionsPager Method

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Lists the metric definitions for a specified resource.

```go
func (client *MetricsClient) NewListDefinitionsPager(resourceURI string, options *MetricsClientListDefinitionsOptions) *runtime.Pager[MetricsClientListDefinitionsResponse]
```

--------------------------------

### Query Workspace Method

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Executes an Analytics query for data within a specific workspace.

```go
func (client *LogsClient) QueryWorkspace(ctx context.Context, workspaceID string, body Body, options *LogsClientQueryWorkspaceOptions) (LogsClientQueryWorkspaceResponse, error)
```

--------------------------------

### Execute Resource Queries

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Executes an Analytics query within the context of a specific resource.

```go
func (client *LogsClient) QueryResource(ctx context.Context, resourceID string, body Body, options *LogsClientQueryResourceOptions) (LogsClientQueryResourceResponse, error)
```

--------------------------------

### Execute Batch Queries

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Executes a batch of Analytics queries. Returns an *azcore.ResponseError on failure.

```go
func (client *LogsClient) QueryBatch(ctx context.Context, body BatchRequest, options *LogsClientQueryBatchOptions) (LogsClientQueryBatchResponse, error)
```

--------------------------------

### Batch Request and Response Containers

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Structures for grouping multiple batch query requests and responses.

```go
type BatchRequest struct {
	Requests []*BatchQueryRequest
}
```

```go
func (b BatchRequest) MarshalJSON() ([]byte, error)
```

```go
func (b *BatchRequest) UnmarshalJSON(data []byte) error
```

```go
type BatchResponse struct {
	Responses []*BatchQueryResponse
}
```

```go
func (b BatchResponse) MarshalJSON() ([]byte, error)
```

```go
func (b *BatchResponse) UnmarshalJSON(data []byte) error
```

--------------------------------

### MetricsClient Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Internal structure for the MetricsClient. Use a constructor function instead of direct instantiation.

```go
type MetricsClient struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### NewMetricsClient

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Creates a new client instance to access Azure Monitor metrics data using provided credentials and options.

```APIDOC
## NewMetricsClient

### Description
Creates a client that accesses Azure Monitor metrics data.

### Signature
`func NewMetricsClient(credential azcore.TokenCredential, options *MetricsClientOptions) (*MetricsClient, error)`
```

--------------------------------

### MetricsClientQueryResourceOptions Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional parameters for the QueryResource method.

```go
type MetricsClientQueryResourceOptions struct {
	// The list of aggregation types to retrieve
	Aggregation []*AggregationType

	// When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest
	// supported timespan. When set to false, an error is returned for invalid
	// timespan parameters. Defaults to false.
	AutoAdjustTimegrain *bool
```

--------------------------------

### Batch Query Request Path Constants

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the path for batch requests, defaulting to /query.

```go
type BatchQueryRequestPath string

const (
	BatchQueryRequestPathQuery BatchQueryRequestPath = "/query"
)
```

```go
func PossibleBatchQueryRequestPathValues() []BatchQueryRequestPath
```

--------------------------------

### Batch Query Request Method Constants

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the HTTP method for batch requests, defaulting to POST.

```go
type BatchQueryRequestMethod string

const (
	BatchQueryRequestMethodPOST BatchQueryRequestMethod = "POST"
)
```

```go
func PossibleBatchQueryRequestMethodValues() []BatchQueryRequestMethod
```

--------------------------------

### Logs Client Query Workspace Response

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Response structure for the QueryWorkspace method.

```go
type LogsClientQueryWorkspaceResponse struct {
	// Contains the tables, columns & rows resulting from a query.
	Results
}
```

--------------------------------

### Define LocalizableString Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents a string that can be localized.

```go
type LocalizableString struct {
	// REQUIRED; The invariant value.
	Value *string

	// The display name.
	LocalizedValue *string
}
```

--------------------------------

### Logs Client Query Batch Response

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Response structure for the QueryBatch method.

```go
type LogsClientQueryBatchResponse struct {
	// Response to a batch query.
	BatchResponse
}
```

--------------------------------

### MetricsClientListDefinitionsOptions Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional parameters for the NewListDefinitionsPager method.

```go
type MetricsClientListDefinitionsOptions struct {
	// Metric namespace where the metrics you want reside.
	MetricNamespace *string
}
```

--------------------------------

### Logs Client Query Resource Response

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Response structure for the QueryResource method.

```go
type LogsClientQueryResourceResponse struct {
	// Contains the tables, columns & rows resulting from a query.
	Results
}
```

--------------------------------

### NewListNamespacesPager Method

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Lists the metric namespaces for a specified resource.

```go
func (client *MetricsClient) NewListNamespacesPager(resourceURI string, options *MetricsClientListNamespacesOptions) *runtime.Pager[MetricsClientListNamespacesResponse]
```

--------------------------------

### Metric Availability Configuration

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Specifies the aggregation interval and retention period for metrics.

```go
type MetricAvailability struct {
	// The retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc.
	Retention *string

	// The time grain specifies a supported aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc.
	TimeGrain *string
}
```

```go
func (m MetricAvailability) MarshalJSON() ([]byte, error)
```

```go
func (m *MetricAvailability) UnmarshalJSON(data []byte) error
```

--------------------------------

### Retrieve possible NamespaceClassification values

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Returns the list of all valid values for the NamespaceClassification type.

```go
func PossibleNamespaceClassificationValues() []NamespaceClassification
```

--------------------------------

### Table and Row Definitions

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Structures for handling tabular data rows and columns, with JSON serialization support.

```go
type Row []any
```

```go
type Table struct {
	// REQUIRED; The list of columns in this table.
	Columns []*Column

	// REQUIRED; The name of the table.
	Name *string

	// REQUIRED; The resulting rows from this query.
	Rows []Row
}
```

```go
func (t Table) MarshalJSON() ([]byte, error)
```

```go
func (t *Table) UnmarshalJSON(data []byte) error
```

--------------------------------

### Define MetricNamespace structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents the structure of a metric namespace.

```go
type MetricNamespace struct {
	// Kind of namespace
	Classification *NamespaceClassification

	// The ID of the metric namespace.
	ID *string

	// The escaped name of the namespace.
	Name *string

	// Properties which include the fully qualified namespace name.
	Properties *MetricNamespaceName
```

--------------------------------

### QueryBatch

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Executes a batch of Analytics queries for data.

```APIDOC
## func (*LogsClient) QueryBatch

### Description
Executes a batch of Analytics queries for data. If the operation fails it returns an *azcore.ResponseError type.

### Signature
`func (client *LogsClient) QueryBatch(ctx context.Context, body BatchRequest, options *LogsClientQueryBatchOptions) (LogsClientQueryBatchResponse, error)`
```

--------------------------------

### Define MetricDefinitionCollection structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents a collection of metric definitions.

```go
type MetricDefinitionCollection struct {
	// REQUIRED; The values for the metric definitions.
	Value []*MetricDefinition
}
```

--------------------------------

### Define Cloud Service Names

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Constants used to identify the cloud service configuration for Logs and Metrics.

```go
const (
	ServiceNameLogs    cloud.ServiceName = "azqueryLogs"
	ServiceNameMetrics cloud.ServiceName = "azqueryMetrics"
)
```

--------------------------------

### MetricNamespace Structure and JSON Methods

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the metadata for a metric namespace with custom JSON marshaling and unmarshaling implementations.

```go
func (m MetricNamespace) MarshalJSON() ([]byte, error)
```

```go
func (m *MetricNamespace) UnmarshalJSON(data []byte) error
```

--------------------------------

### Define BatchQueryRequest Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Data structure for submitting a batch query request, including required body, correlation ID, and workspace ID.

```go
type BatchQueryRequest struct {
	// REQUIRED; The Analytics query. Learn more about the Analytics query syntax [https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/]
	Body *Body

	// REQUIRED; Unique ID corresponding to each request in the batch.
	CorrelationID *string

	// REQUIRED; Primary Workspace ID of the query. This is the Workspace ID from the Properties blade in the Azure portal.
	WorkspaceID *string

	// Headers of the request. Can use prefer header to set server timeout and to query statistics and visualization information.
	Headers map[string]*string

	// The method of a single request in a batch, defaults to POST
	Method *BatchQueryRequestMethod
```

--------------------------------

### Batch Query Results Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Contains the tabular data, statistics, and visualization results from a query.

```go
type BatchQueryResults struct {
	Error *ErrorInfo
	Statistics []byte
	Tables []*Table
	Visualization []byte
}
```

```go
func (b BatchQueryResults) MarshalJSON() ([]byte, error)
```

```go
func (b *BatchQueryResults) UnmarshalJSON(data []byte) error
```

--------------------------------

### MetricNamespaceCollection Structure and JSON Methods

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents a collection of metric namespaces with custom JSON marshaling and unmarshaling.

```go
type MetricNamespaceCollection struct {
	// REQUIRED; The values for the metric namespaces.
	Value []*MetricNamespace
}
```

```go
func (m MetricNamespaceCollection) MarshalJSON() ([]byte, error)
```

```go
func (m *MetricNamespaceCollection) UnmarshalJSON(data []byte) error
```

--------------------------------

### QueryResource

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Lists the metric values for a specific resource.

```APIDOC
## QueryResource

### Description
Lists the metric values for a resource. If the operation fails it returns an *azcore.ResponseError type.

### Signature
`func (client *MetricsClient) QueryResource(ctx context.Context, resourceURI string, options *MetricsClientQueryResourceOptions) (MetricsClientQueryResourceResponse, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **resourceURI** (string) - Required - The identifier of the resource.
- **options** (*MetricsClientQueryResourceOptions) - Optional - Contains optional parameters for the method.
```

--------------------------------

### Define NamespaceClassification type and constants

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the classification of a namespace and its possible values.

```go
type NamespaceClassification string
```

```go
const (
	NamespaceClassificationCustom   NamespaceClassification = "Custom"
	NamespaceClassificationPlatform NamespaceClassification = "Platform"
	NamespaceClassificationQos      NamespaceClassification = "Qos"
)
```

--------------------------------

### Batch Query Response Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the structure for a batch query response, including headers and status.

```go
type BatchQueryResponse struct {
	Body          *BatchQueryResults
	CorrelationID *string

	Headers map[string]*string
	Status  *int32
}
```

```go
func (b BatchQueryResponse) MarshalJSON() ([]byte, error)
```

```go
func (b *BatchQueryResponse) UnmarshalJSON(data []byte) error
```

--------------------------------

### MetricsClientListDefinitionsResponse Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Response structure for the NewListDefinitionsPager method.

```go
type MetricsClientListDefinitionsResponse struct {
	// Represents collection of metric definitions.
	MetricDefinitionCollection
}
```

--------------------------------

### Metric Definition Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Contains metadata and configuration for a metric definition, including dimensions and supported aggregations.

```go
type MetricDefinition struct {
	// Custom category name for this metric.
	Category *string

	// The name and the display name of the dimension, i.e. it is a localizable string.
	Dimensions []*LocalizableString

	// Detailed description of this metric.
	DisplayDescription *string

	// The resource identifier of the metric definition.
	ID *string

	// Flag to indicate whether the dimension is required.
	IsDimensionRequired *bool

	// The collection of what aggregation intervals are available to be queried.
	MetricAvailabilities []*MetricAvailability

	// The class of the metric.
	MetricClass *MetricClass

	// The name and the display name of the metric, i.e. it is a localizable string.
	Name *LocalizableString

	// The namespace the metric belongs to.
	Namespace *string

	// The primary aggregation type value defining how to use the values for display.
	PrimaryAggregationType *AggregationType

	// The resource identifier of the resource that emitted the metric.
	ResourceID *string

	// The collection of what aggregation types are supported.
	SupportedAggregationTypes []*AggregationType
}
```

--------------------------------

### Batch Query Request JSON Marshaling

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Methods for marshaling and unmarshaling BatchQueryRequest objects.

```go
func (b BatchQueryRequest) MarshalJSON() ([]byte, error)
```

```go
func (b *BatchQueryRequest) UnmarshalJSON(data []byte) error
```

--------------------------------

### MetricsClientListNamespacesOptions Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Optional parameters for the NewListNamespacesPager method.

```go
type MetricsClientListNamespacesOptions struct {
	// The ISO 8601 conform Date start time from which to query for metric namespaces.
	StartTime *string
}
```

--------------------------------

### Define Response structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents the standard response structure for metric queries.

```go
type Response struct {
	// REQUIRED; The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by
	// '/'. This may be adjusted in the future and returned back from what was originally
	// requested.
	Timespan *TimeInterval

	// REQUIRED; The value of the collection.
	Value []*Metric

	// The integer value representing the relative cost of the query.
	Cost *int32

	// The interval (window size) for which the metric data was returned in ISO 8601 duration format with a special case for 'FULL'
	// value that returns single datapoint for entire time span requested (
	// Examples: PT15M, PT1H, P1D, FULL). This may be adjusted and different from what was originally requested if AutoAdjustTimegrain=true
	// is specified. This is not present if a metadata request was made.
	Interval *string

	// The namespace of the metrics being queried
	Namespace *string
}
```

--------------------------------

### Response JSON Serialization

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Methods for marshaling and unmarshaling the Response type to and from JSON.

```go
func (r Response) MarshalJSON() ([]byte, error)
```

```go
func (r *Response) UnmarshalJSON(data []byte) error
```

--------------------------------

### NewListDefinitionsPager

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Lists the metric definitions for a specified resource.

```APIDOC
## NewListDefinitionsPager

### Description
Lists the metric definitions for the resource.

### Signature
`func (client *MetricsClient) NewListDefinitionsPager(resourceURI string, options *MetricsClientListDefinitionsOptions) *runtime.Pager[MetricsClientListDefinitionsResponse]`

### Parameters
- **resourceURI** (string) - Required - The identifier of the resource.
- **options** (*MetricsClientListDefinitionsOptions) - Optional - Contains optional parameters for the method.
```

--------------------------------

### MetricNamespaceName Structure and JSON Methods

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents the fully qualified metric namespace name with custom JSON marshaling and unmarshaling.

```go
type MetricNamespaceName struct {
	// The metric namespace name.
	MetricNamespaceName *string
}
```

```go
func (m MetricNamespaceName) MarshalJSON() ([]byte, error)
```

```go
func (m *MetricNamespaceName) UnmarshalJSON(data []byte) error
```

--------------------------------

### Metric Class Definitions

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the classification of metrics and provides a helper to retrieve all possible values.

```go
type MetricClass string
```

```go
const (
	MetricClassAvailability MetricClass = "Availability"
	MetricClassErrors       MetricClass = "Errors"
	MetricClassLatency      MetricClass = "Latency"
	MetricClassSaturation   MetricClass = "Saturation"
	MetricClassTransactions MetricClass = "Transactions"
)
```

```go
func PossibleMetricClassValues() []MetricClass
```

--------------------------------

### Marshal and Unmarshal LocalizableString

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Methods to serialize and deserialize the LocalizableString type.

```go
func (l LocalizableString) MarshalJSON() ([]byte, error)
```

```go
func (l *LocalizableString) UnmarshalJSON(data []byte) error
```

--------------------------------

### MetricsClient.QueryResource

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Queries metric data for a specific resource using the provided options.

```APIDOC
## MetricsClient.QueryResource

### Description
Queries metric data for a specific resource. This method accepts a set of optional parameters defined in MetricsClientQueryResourceOptions to filter, aggregate, and format the returned metric data.

### Parameters
- **resourceURI** (string) - Required - The resource identifier for the metrics query.
- **options** (*MetricsClientQueryResourceOptions) - Optional - Configuration options including Filter, Interval, MetricNames, MetricNamespace, OrderBy, ResultType, RollUpBy, Timespan, Top, and ValidateDimensions.

### Response
- **MetricsClientQueryResourceResponse** - Contains the metric data, cost, interval, and timespan information.
```

--------------------------------

### Possible Logs Column Type Values

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Returns the possible values for the LogsColumnType constant type.

```go
func PossibleLogsColumnTypeValues() []LogsColumnType
```

--------------------------------

### MetricsClientListNamespacesResponse Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Response structure for the NewListNamespacesPager method.

```go
type MetricsClientListNamespacesResponse struct {
	// Represents collection of metric namespaces.
	MetricNamespaceCollection
}
```

--------------------------------

### Metric Data Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the structure for metric query results, including ID, name, time series, and error details.

```go
type Metric struct {
	// REQUIRED; The metric Id.
	ID *string

	// REQUIRED; The name and the display name of the metric, i.e. it is localizable string.
	Name *LocalizableString

	// REQUIRED; The time series returned when a data query is performed.
	TimeSeries []*TimeSeriesElement

	// REQUIRED; The resource type of the metric resource.
	Type *string

	// REQUIRED; The unit of the metric.
	Unit *MetricUnit

	// Detailed description of this metric.
	DisplayDescription *string

	// 'Success' or the error details on query failures for this metric.
	ErrorCode *string

	// Error message encountered querying this specific metric.
	ErrorMessage *string
}
```

```go
func (m Metric) MarshalJSON() ([]byte, error)
```

```go
func (m *Metric) UnmarshalJSON(data []byte) error
```

--------------------------------

### Marshal MetricDefinition to JSON

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Implements the json.Marshaller interface for the MetricDefinition type.

```go
func (m MetricDefinition) MarshalJSON() ([]byte, error)
```

--------------------------------

### Query Body Definition

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the body structure for a query execution request.

```go
type Body struct {
	Query *string
	AdditionalWorkspaces []*string
```

--------------------------------

### NewTimeInterval

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Creates a TimeInterval for use in a query, following the ISO8601 time interval standard.

```APIDOC
## func NewTimeInterval

### Description
Creates a TimeInterval for use in a query. Use UTC for start and end times.

### Signature
`func NewTimeInterval(start time.Time, end time.Time) TimeInterval`

### Parameters
- **start** (time.Time) - Required - The start time of the interval.
- **end** (time.Time) - Required - The end time of the interval.

### Returns
- **TimeInterval** - A formatted time interval string.
```

--------------------------------

### NewBatchQueryRequest

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Creates a new instance of a BatchQueryRequest for use in batch operations.

```APIDOC
## func NewBatchQueryRequest

### Description
Creates a new BatchQueryRequest instance with the specified workspace ID, query, timespan, correlation ID, and options.

### Signature
`func NewBatchQueryRequest(workspaceID string, query string, timespan TimeInterval, correlationID string, options LogsQueryOptions) BatchQueryRequest`

### Parameters
- **workspaceID** (string) - Required - The ID of the workspace to query.
- **query** (string) - Required - The query string to execute.
- **timespan** (TimeInterval) - Required - The time range for the query.
- **correlationID** (string) - Required - The correlation ID for the request.
- **options** (LogsQueryOptions) - Required - Additional query options.
```

--------------------------------

### Metadata Value Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents a metadata value with a name.

```go
type MetadataValue struct {
	// The name of the metadata.
	Name *LocalizableString
```

--------------------------------

### Marshal and Unmarshal Column

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Methods to serialize and deserialize the Column type.

```go
func (c Column) MarshalJSON() ([]byte, error)
```

```go
func (c *Column) UnmarshalJSON(data []byte) error
```

--------------------------------

### ErrorInfo Error Handling

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Methods for ErrorInfo to implement the error interface and handle JSON unmarshaling.

```go
func (e *ErrorInfo) Error() string
```

```go
func (e *ErrorInfo) UnmarshalJSON(data []byte) error
```

--------------------------------

### Define Column Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents a column in a table with a name and data type.

```go
type Column struct {
	// The name of this column.
	Name *string

	// The data type of this column.
	Type *LogsColumnType
}
```

--------------------------------

### Marshal and Unmarshal Body

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Methods to serialize and deserialize the Body type using the json.Marshaller and json.Unmarshaller interfaces.

```go
func (b Body) MarshalJSON() ([]byte, error)
```

```go
func (b *Body) UnmarshalJSON(data []byte) error
```

--------------------------------

### ResultType Constants

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the allowed result types for data collection and provides a helper to retrieve all possible values.

```go
type ResultType string
```

```go
const (
	ResultTypeData     ResultType = "Data"
	ResultTypeMetadata ResultType = "Metadata"
)
```

```go
func PossibleResultTypeValues() []ResultType
```

--------------------------------

### Define MetricsClientQueryResourceResponse structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Structure representing the response from the MetricsClient.QueryResource method.

```go
type MetricsClientQueryResourceResponse struct {
	// The response to a metrics query.
	Response
}
```

--------------------------------

### NewListNamespacesPager

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Lists the metric namespaces for a specified resource.

```APIDOC
## NewListNamespacesPager

### Description
Lists the metric namespaces for the resource.

### Signature
`func (client *MetricsClient) NewListNamespacesPager(resourceURI string, options *MetricsClientListNamespacesOptions) *runtime.Pager[MetricsClientListNamespacesResponse]`

### Parameters
- **resourceURI** (string) - Required - The identifier of the resource.
- **options** (*MetricsClientListNamespacesOptions) - Optional - Contains optional parameters for the method.
```

--------------------------------

### QueryResource

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Executes an Analytics query for data in the context of a specific resource.

```APIDOC
## func (*LogsClient) QueryResource

### Description
Executes an Analytics query for data in the context of a resource. If the operation fails it returns an *azcore.ResponseError type.

### Signature
`func (client *LogsClient) QueryResource(ctx context.Context, resourceID string, body Body, options *LogsClientQueryResourceOptions) (LogsClientQueryResourceResponse, error)`
```

--------------------------------

### MetadataValue Structure and JSON Marshaling

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents a metric metadata value with custom JSON marshaling implementations.

```go
func (m MetadataValue) MarshalJSON() ([]byte, error)
```

```go
func (m *MetadataValue) UnmarshalJSON(data []byte) error
```

--------------------------------

### func (*LogsClient) QueryWorkspace

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Executes an Analytics query for data within a specific Azure workspace.

```APIDOC
## func (*LogsClient) QueryWorkspace

### Description
Executes an Analytics query for data. This method interacts with the Azure Monitor Logs service to retrieve query results.

### Signature
`func (client *LogsClient) QueryWorkspace(ctx context.Context, workspaceID string, body Body, options *LogsClientQueryWorkspaceOptions) (LogsClientQueryWorkspaceResponse, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **workspaceID** (string) - Required - Primary Workspace ID of the query.
- **body** (Body) - Required - The Analytics query to execute.
- **options** (*LogsClientQueryWorkspaceOptions) - Optional - Contains optional parameters for the query, such as server timeout, statistics, and visualization settings.

### Returns
- **LogsClientQueryWorkspaceResponse** - Contains the tables, columns, and rows resulting from the query.
- **error** - Returns an *azcore.ResponseError if the operation fails.
```

--------------------------------

### Logs Column Type Definition

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the data type of a column and its possible values.

```go
type LogsColumnType string
```

```go
const (
	LogsColumnTypeBool     LogsColumnType = "bool"
	LogsColumnTypeDatetime LogsColumnType = "datetime"
	LogsColumnTypeDecimal  LogsColumnType = "decimal"
	LogsColumnTypeDynamic  LogsColumnType = "dynamic"
	LogsColumnTypeGUID     LogsColumnType = "guid"
	LogsColumnTypeInt      LogsColumnType = "int"
	LogsColumnTypeLong     LogsColumnType = "long"
	LogsColumnTypeReal     LogsColumnType = "real"
	LogsColumnTypeString   LogsColumnType = "string"
	LogsColumnTypeTimespan LogsColumnType = "timespan"
)
```

--------------------------------

### TimeSeriesElement Serialization

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Data structure for time series results with JSON serialization methods.

```go
type TimeSeriesElement struct {
	// An array of data points representing the metric values. This is only returned if a result type of data is specified.
	Data []*MetricValue

	// The metadata values returned if $filter was specified in the call.
	MetadataValues []*MetadataValue
}
```

```go
func (t TimeSeriesElement) MarshalJSON() ([]byte, error)
```

```go
func (t *TimeSeriesElement) UnmarshalJSON(data []byte) error
```

--------------------------------

### Marshal MetricDefinitionCollection to JSON

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Implements the json.Marshaller interface for the MetricDefinitionCollection type.

```go
func (m MetricDefinitionCollection) MarshalJSON() ([]byte, error)
```

--------------------------------

### Results Data Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents the tabular results of a query, including statistics and visualization data.

```go
type Results struct {
	// REQUIRED; The results of the query in tabular format.
	Tables []*Table

	// The code and message for an error.
	Error *ErrorInfo

	// Statistics represented in JSON format.
	Statistics []byte

	// Visualization data in JSON format.
	Visualization []byte
}
```

```go
func (r Results) MarshalJSON() ([]byte, error)
```

```go
func (r *Results) UnmarshalJSON(data []byte) error
```

--------------------------------

### MetricValue Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Defines the structure for a single metric value, including timestamp and statistical aggregates.

```go
type MetricValue struct {
	// REQUIRED; The timestamp for the metric value in ISO 8601 format.
	TimeStamp *time.Time

	// The average value in the time range.
	Average *float64

	// The number of samples in the time range. Can be used to determine the number of values that contributed to the average
	// value.
	Count *float64

	// The greatest value in the time range.
	Maximum *float64

	// The least value in the time range.
	Minimum *float64
```

--------------------------------

### Unmarshal MetricDefinition from JSON

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Implements the json.Unmarshaller interface for the MetricDefinition type.

```go
func (m *MetricDefinition) UnmarshalJSON(data []byte) error
```

--------------------------------

### Define ErrorInfo Structure

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Represents error information including a machine-readable code.

```go
type ErrorInfo struct {
	// REQUIRED; A machine readable error code.
	Code string
	// contains filtered or unexported fields
}
```

--------------------------------

### Retrieve Possible AggregationType Values

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Function to return all valid values for the AggregationType constant type.

```go
func PossibleAggregationTypeValues() []AggregationType
```

--------------------------------

### MarshalJSON for MetricValue

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Implements the json.Marshaller interface for the MetricValue type.

```go
func (m MetricValue) MarshalJSON() ([]byte, error)
```

--------------------------------

### Unmarshal MetricDefinitionCollection from JSON

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Implements the json.Unmarshaller interface for the MetricDefinitionCollection type.

```go
func (m *MetricDefinitionCollection) UnmarshalJSON(data []byte) error
```

--------------------------------

### PossibleNamespaceClassificationValues

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Retrieves the list of supported namespace classification values.

```APIDOC
## PossibleNamespaceClassificationValues

### Description
Returns the possible values for the NamespaceClassification type, which categorizes metric namespaces (e.g., Custom, Platform, Qos).

### Response
- **[]NamespaceClassification** - A slice of supported classification strings.
```

--------------------------------

### Define AggregationType

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Type definition and constant values for metric aggregation types.

```go
type AggregationType string
```

```go
const (
	AggregationTypeAverage AggregationType = "Average"
	AggregationTypeCount   AggregationType = "Count"
	AggregationTypeMaximum AggregationType = "Maximum"
	AggregationTypeMinimum AggregationType = "Minimum"
	AggregationTypeNone    AggregationType = "None"
	AggregationTypeTotal   AggregationType = "Total"
)
```

--------------------------------

### UnmarshalJSON for MetricValue

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Implements the json.Unmarshaller interface for the MetricValue type.

```go
func (m *MetricValue) UnmarshalJSON(data []byte) error
```

--------------------------------

### PossibleResultTypeValues

Source: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery

Returns the possible values for the ResultType constant type.

```APIDOC
## func PossibleResultTypeValues

### Description
Returns the possible values for the ResultType const type.

### Signature
`func PossibleResultTypeValues() []ResultType`

### Returns
- **[]ResultType** - A slice containing the supported ResultType values.
```
Tokens:
Raw