Log Analytics - Export Request Rate By Interval

Service:

Compute

API Version:

2026-03-01

Export logs that show Api requests made by this subscription in the given time window to show throttling activities.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval?api-version=2026-03-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of Azure region.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
blobContainerSasUri	True	string	SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
fromTime	True	string (date-time)	From time of the query
intervalLength	True	IntervalInMins	Interval value in minutes used to create LogAnalytics call rate logs.
toTime	True	string (date-time)	To time of the query
groupByClientApplicationId		boolean	Group query result by Client Application ID.
groupByOperationName		boolean	Group query result by Operation Name.
groupByResourceName		boolean	Group query result by Resource Name.
groupByThrottlePolicy		boolean	Group query result by Throttle Policy applied.
groupByUserAgent		boolean	Group query result by User Agent.

Responses

Name	Type	Description
200 OK	LogAnalyticsOperationResult	The request has succeeded.
202 Accepted		Resource operation accepted. Headers Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.

Sample request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus/logAnalytics/apiAccess/getRequestRateByInterval?api-version=2026-03-01

{
  "intervalLength": "FiveMins",
  "blobContainerSasUri": "https://somesasuri",
  "fromTime": "2018-01-21T01:54:06.862601Z",
  "toTime": "2018-01-23T01:54:06.862601Z",
  "groupByResourceName": true
}

Java

import com.azure.resourcemanager.compute.models.IntervalInMins;
import com.azure.resourcemanager.compute.models.RequestRateByIntervalInput;
import java.time.OffsetDateTime;

/**
 * Samples for LogAnalytics ExportRequestRateByInterval.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json
     */
    /**
     * Sample code: Export logs which contain all Api requests made to Compute Resource Provider within the given time
     * period broken down by intervals.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void
        exportLogsWhichContainAllApiRequestsMadeToComputeResourceProviderWithinTheGivenTimePeriodBrokenDownByIntervals(
            com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getLogAnalytics().exportRequestRateByInterval("westus",
            new RequestRateByIntervalInput().withBlobContainerSasUri("https://somesasuri")
                .withFromTime(OffsetDateTime.parse("2018-01-21T01:54:06.862601Z"))
                .withToTime(OffsetDateTime.parse("2018-01-23T01:54:06.862601Z")).withGroupByResourceName(true)
                .withIntervalLength(IntervalInMins.FIVE_MINS),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python log_analytics_request_rate_by_interval.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.log_analytics.begin_export_request_rate_by_interval(
        location="westus",
        parameters={
            "blobContainerSasUri": "https://somesasuri",
            "fromTime": "2018-01-21T01:54:06.862601Z",
            "groupByResourceName": True,
            "intervalLength": "FiveMins",
            "toTime": "2018-01-23T01:54:06.862601Z",
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-01/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"
	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2026-03-01/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json
func ExampleLogAnalyticsClient_BeginExportRequestRateByInterval() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewLogAnalyticsClient().BeginExportRequestRateByInterval(ctx, "westus", armcompute.RequestRateByIntervalInput{
		IntervalLength:      to.Ptr(armcompute.IntervalInMinsFiveMins),
		BlobContainerSasURI: to.Ptr("https://somesasuri"),
		FromTime:            to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-21T01:54:06.862601Z"); return t }()),
		ToTime:              to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-23T01:54:06.862601Z"); return t }()),
		GroupByResourceName: to.Ptr(true),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.LogAnalyticsClientExportRequestRateByIntervalResponse{
	// 	LogAnalyticsOperationResult: armcompute.LogAnalyticsOperationResult{
	// 		Properties: &armcompute.LogAnalyticsOutput{
	// 			Output: to.Ptr("https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to export logs that show Api requests made by this subscription in the given time window to show throttling activities.
 *
 * @summary export logs that show Api requests made by this subscription in the given time window to show throttling activities.
 * x-ms-original-file: 2026-03-01/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json
 */
async function exportLogsWhichContainAllApiRequestsMadeToComputeResourceProviderWithinTheGivenTimePeriodBrokenDownByIntervals() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.logAnalytics.exportRequestRateByInterval("westus", {
    intervalLength: "FiveMins",
    blobContainerSasUri: "https://somesasuri",
    fromTime: new Date("2018-01-21T01:54:06.862601Z"),
    toTime: new Date("2018-01-23T01:54:06.862601Z"),
    groupByResourceName: true,
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {
    "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv"
  }
}

Status code:

202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2025-04-01

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
InnerError	Inner error details.
IntervalInMins	Interval value in minutes used to create LogAnalytics call rate logs.
LogAnalyticsOperationResult	LogAnalytics operation status response
LogAnalyticsOutput	LogAnalytics output properties
RequestRateByIntervalInput	Api request input for LogAnalytics getRequestRateByInterval Api.

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

Api error base.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

IntervalInMins

Enumeration

Interval value in minutes used to create LogAnalytics call rate logs.

Value	Description
ThreeMins
FiveMins
ThirtyMins
SixtyMins

LogAnalyticsOperationResult

Object

LogAnalytics operation status response

Name	Type	Description
properties	LogAnalyticsOutput	LogAnalyticsOutput

LogAnalyticsOutput

Object

LogAnalytics output properties

Name	Type	Description
output	string	Output file Uri path to blob container.

RequestRateByIntervalInput

Object

Api request input for LogAnalytics getRequestRateByInterval Api.

Name	Type	Description
blobContainerSasUri	string	SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
fromTime	string (date-time)	From time of the query
groupByClientApplicationId	boolean	Group query result by Client Application ID.
groupByOperationName	boolean	Group query result by Operation Name.
groupByResourceName	boolean	Group query result by Resource Name.
groupByThrottlePolicy	boolean	Group query result by Throttle Policy applied.
groupByUserAgent	boolean	Group query result by User Agent.
intervalLength	IntervalInMins	Interval value in minutes used to create LogAnalytics call rate logs.
toTime	string (date-time)	To time of the query