< Back

Export-AzureRmLogAnalyticRequestRateByInterval

Tue Jan 29, 2019 9:37 pm

NAME Export-AzureRmLogAnalyticRequestRateByInterval



SYNOPSIS

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





SYNTAX

Export-AzureRmLogAnalyticRequestRateByInterval [-Location] <String> [-FromTime] <DateTime> [-ToTime] <DateTime> [-BlobContainerSasUri] <String>

[-IntervalLength] {ThreeMins | FiveMins | ThirtyMins | SixtyMins} [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-GroupByOperationName]

[-GroupByResourceName] [-GroupByThrottlePolicy] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

This exports aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled displayed in time intervals. The logs

can be further grouped by three parameters: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName. Note that this cmdlet collects

only CRP logs.





PARAMETERS

-AsJob [<SwitchParameter>]

Run cmdlet in the background



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-BlobContainerSasUri <String>

SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.



Required? true

Position? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with Azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FromTime <DateTime>

From time of the query



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-GroupByOperationName [<SwitchParameter>]

Group query result by Operation Name.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-GroupByResourceName [<SwitchParameter>]

Group query result by Resource Name.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-GroupByThrottlePolicy [<SwitchParameter>]

Group query result by Throttle Policy applied.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-IntervalLength <IntervalInMins>

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



Required? true

Position? 5

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Location <String>

The location upon which log analytic is queried.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ToTime <DateTime>

To time of the query



Required? true

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult







NOTES









Example 1



PS C:\\> Export-AzureRmLogAnalyticRequestRateByInterval -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 ... someSasUri' -IntervalLength ThirtyMins

-GroupByOperationName



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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... byinterval