New-UnityMetricRealTimeQuery

SYNOPSIS

Creates a new metrics real-time query.

SYNTAX

New-UnityMetricRealTimeQuery [[-session] <Object>] [-paths] <Object> [-interval] <UInt64> [-WhatIf] [-Confirm]

DESCRIPTION

Creates a new metrics real-time query. After you create this query, the results are available whith the command Get-UnityMetricQueryResult

EXAMPLES

-------------------------- EXEMPLE 1 --------------------------

New-UnityMetricRealTimeQuery -paths sp.*.cpu.uptime -interval 60

Create a new query to gather statisitics about 'sp.*.cpu.uptime'.

PARAMETERS

-session

Specify an UnitySession Object.

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: ($global:DefaultUnitySession | where-object {$_.IsConnected -eq $true})
Accept pipeline input: False
Accept wildcard characters: False

-paths

Metric stat paths associated with the query.

Type: Object
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-interval

Sampling frequency for the query in seconds.

Type: UInt64
Parameter Sets: (All)
Aliases: 

Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

INPUTS

OUTPUTS

NOTES

Written by Erwan Quelin under MIT licence - https://github.com/equelin/Unity-Powershell/blob/master/LICENSE

https://github.com/equelin/Unity-Powershell