Export-AzLogAnalyticRequestRateByInterval

Module:

Az.Compute Module

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

Export-AzLogAnalyticRequestRateByInterval
 [-Location] <String>
 [-FromTime] <DateTime>
 [-ToTime] <DateTime>
 [-BlobContainerSasUri] <String>
 [-IntervalLength] <IntervalInMins>
 [-GroupByOperationName]
 [-GroupByResourceName]
 [-GroupByThrottlePolicy]
 [-GroupByApplicationId]
 [-GroupByUserAgent]
 [-AsJob]
 [-NoWait]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Exports statistical data about the subscription's calls to the Microsoft.Compute API by Success, Failure, or Throttled status, in predefined time intervals. The logs can be further grouped by five parameters: GroupByOperationName, GroupByThrottlePolicy, GroupByResourceName, GroupByUserAgent, or GroupByApplicationId. Note that this cmdlet collects only Compute Resource Provider logs; moreover, data about the Disk and Snapshot resource types is not yet available.

For an overview of the Compute Resource Provider's API throttling, see https://learn.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits.

Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByOperationName

This command downloads a .csv file to the provided container. The format of the file is:

TIMESTAMP operationName TotalRequests SuccessfulRequests ThrottledRequests
--------- ------------- ------------- ------------------ -----------------
2/21/2018 7:00:00 PM <operationName> 10 10 0
2/21/2018 7:30:00 PM <operationName> 8 8 0
2/21/2018 9:00:00 PM <operationName> 9 9 0

This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name.

Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByApplicationId

This command downloads a .csv file to the provided container. The format of the file is:

TIMESTAMP clientApplicationId TotalRequests SuccessfulRequests ThrottledRequests
--------- ------------------- ------------- ------------------ -----------------
2/21/2018 7:00:00 PM <clientApplicationId> 10 10 0
2/21/2018 7:30:00 PM <clientApplicationId> 8 8 0
2/21/2018 9:00:00 PM <clientApplicationId> 9 9 0

This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by application id.

Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByUserAgent

This command downloads a .csv file to the provided container. The format of the file is:

TIMESTAMP userAgent TotalRequests SuccessfulRequests ThrottledRequests
--------- --------- ------------- ------------------ -----------------
2/21/2018 7:00:00 PM <userAgent> 10 10 0
2/21/2018 7:30:00 PM <userAgent> 8 8 0
2/21/2018 9:00:00 PM <userAgent> 9 9 0

This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by user agent.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.