Get-AzAutoscalePredictiveMetric

get predictive autoscale metric future data

Syntax

Get-AzAutoscalePredictiveMetric
   -InputObject <IAutoscaleIdentity>
   -Aggregation <String>
   -Interval <TimeSpan>
   -MetricName <String>
   -MetricNamespace <String>
   -Timespan <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzAutoscalePredictiveMetric
   -AutoscaleSettingName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -Aggregation <String>
   -Interval <TimeSpan>
   -MetricName <String>
   -MetricNamespace <String>
   -Timespan <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

get predictive autoscale metric future data

Examples

Example 1: Get predictive metric for autoscale setting

Get-AzAutoscalePredictiveMetric -AutoscaleSettingName test-autoscalesetting -ResourceGroupName test-group -Timespan "2021-10-14T22:00:00.000Z/2021-10-16T22:00:00.000Z" -Aggregation "Total" -Interval ([System.TimeSpan]::New(0,60,0)) -MetricName "PercentageCPU" -MetricNamespace "Microsoft.Compute/virtualMachineScaleSets"

Get predictive metric for autoscale setting

Parameters

-Aggregation

The list of aggregation types (comma separated) to retrieve.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AutoscaleSettingName

The autoscale setting name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IAutoscaleIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Interval

The interval (i.e. timegrain) of the query.

Type:TimeSpan
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MetricName

The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MetricNamespace

Metric namespace to query metric definitions for.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Timespan

The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IAutoscaleIdentity

Outputs

IPredictiveResponse