C# Класс Microsoft.Azure.Commands.Insights.EventCmdletBase

Base class for the Azure Insights SDK EventService Cmdlets
Наследование: InsightsClientCmdletBase
Показать файл Открыть проект

Private Properties

Свойство Тип Описание
ProcessGeneralParameters string
ValidateDateTimeRangeAndAdddefaults string

Защищенные методы

Метод Описание
AddConditionIfPResent ( string currentQueryFilter, string name, string value ) : string

Adds a condition to the query filter based on the give name and the value

GetDefaultQueryTimeRange ( ) : System.TimeSpan

Gets the default query time range

KeepTheRecord ( Microsoft.Azure.Insights.Models.EventData record ) : bool

A predicate to filter in/out the records from original list of records obtained from the SDK.

This method is intended to allow descendants of this class to further filter the results.

An example of this is when the filtering is needed based on Category and ResourceUri at the same time. The SDK does not allow these two fields to be in the query filter togheter. So the call should filter by one and then use this function to filter by the second one.

ProcessParameters ( ) : string

Process the general parameters (i.e. defined in this class) and the particular parameters (i.e. the parameters added by the descendants of this class).

ProcessParticularParameters ( string currentQueryFilter ) : string

Process the parameters defined by the descendants of this class

ProcessRecordInternal ( ) : void

Execute the cmdlet

SetMaxEventsIfPresent ( string currentQueryFilter, string name, int value ) : void

Sets the max number of records to fetch

Приватные методы

Метод Описание
ProcessGeneralParameters ( ) : string

Process the parameters defined by this class

ValidateDateTimeRangeAndAdddefaults ( ) : string

Validates that the range of dates (start / end) makes sense, it is not to great (less 15 days), and adds the defaul values if needed

Описание методов

AddConditionIfPResent() защищенный Метод

Adds a condition to the query filter based on the give name and the value
protected AddConditionIfPResent ( string currentQueryFilter, string name, string value ) : string
currentQueryFilter string The current query filter
name string The name to be used in the new condition
value string The value to be used in the new condition.If this value is null, the currentQueryFilter is returned unmodified.
Результат string

GetDefaultQueryTimeRange() защищенный Метод

Gets the default query time range
protected GetDefaultQueryTimeRange ( ) : System.TimeSpan
Результат System.TimeSpan

KeepTheRecord() защищенный Метод

A predicate to filter in/out the records from original list of records obtained from the SDK.

This method is intended to allow descendants of this class to further filter the results.

An example of this is when the filtering is needed based on Category and ResourceUri at the same time. The SDK does not allow these two fields to be in the query filter togheter. So the call should filter by one and then use this function to filter by the second one.

protected KeepTheRecord ( Microsoft.Azure.Insights.Models.EventData record ) : bool
record Microsoft.Azure.Insights.Models.EventData A record from the original list of records obtained from the sdk
Результат bool

ProcessParameters() защищенный Метод

Process the general parameters (i.e. defined in this class) and the particular parameters (i.e. the parameters added by the descendants of this class).
protected ProcessParameters ( ) : string
Результат string

ProcessParticularParameters() защищенный абстрактный Метод

Process the parameters defined by the descendants of this class
protected abstract ProcessParticularParameters ( string currentQueryFilter ) : string
currentQueryFilter string The current query filter
Результат string

ProcessRecordInternal() защищенный Метод

Execute the cmdlet
protected ProcessRecordInternal ( ) : void
Результат void

SetMaxEventsIfPresent() защищенный Метод

Sets the max number of records to fetch
protected SetMaxEventsIfPresent ( string currentQueryFilter, string name, int value ) : void
currentQueryFilter string
name string
value int
Результат void