PSStreamLogger.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: New-AzureApplicationInsightsLogger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-AzureApplicationInsightsLogger</command:name> <command:verb>New</command:verb> <command:noun>AzureApplicationInsightsLogger</command:noun> <maml:description> <maml:para>Creates a new logger that writes log events to an Azure Application Insights instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A logger based on the Serilog.Sinks.ApplicationInsights that writes log events to an Azure Application Insights instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-AzureApplicationInsightsLogger</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string for the target Azure Application Insights instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Properties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An optional hashtable containing additional properties to add to each log event (key = log property name, value = log property value).</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string for the target Azure Application Insights instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Properties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An optional hashtable containing additional properties to add to each log event (key = log property name, value = log property value).</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Logger --> <command:returnValue> <dev:type> <maml:name>PSStreamLoggerModule.Logger</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Invoke-CommandWithLogging --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-CommandWithLogging</command:name> <command:verb>Invoke</command:verb> <command:noun>CommandWithLogging</command:noun> <maml:description> <maml:para>Executes a command and logs PowerShell stream output.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Executes a command and sends data written into PowerShell streams (Verbose, Debug, Information, Warning, Error) as log events to the configured loggers.</maml:para> <maml:para>Output is passed through.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-CommandWithLogging</maml:name> <!-- Parameter: ScriptBlock --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The script block to execute.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableStreamConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableStreamConfiguration</maml:name> <maml:description> <maml:para>Disable the automatic PowerShell stream configuration. based on the lowest log level.</maml:para> <maml:para>By default the PowerShell streams are configured based on the lowest log level across all loggers.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExecutionMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecutionMode</maml:name> <maml:description> <maml:para>The mode to execute the script block in. NewScope executes the script block in a new scope (default), CurrentScope executes it in the current scope (in the same scope this Cmdlet is executed from) and NewRunspace executes it in a new PowerShell runspace.</maml:para> <maml:para>Possible values: NewScope, CurrentScope, NewRunspace</maml:para> </maml:description> <command:parameterValue required="true">ExecutionMode</command:parameterValue> <dev:type> <maml:name>PSStreamLoggerModule.ExecutionMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NewScope</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NewScope</command:parameterValue> <command:parameterValue required="false" variableLength="false">CurrentScope</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewRunspace</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Loggers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Loggers</maml:name> <maml:description> <maml:para>The loggers to send log events to. If no loggers are configured, a console logger with minimum log level information will be used.</maml:para> </maml:description> <command:parameterValue required="true">Logger[]</command:parameterValue> <dev:type> <maml:name>PSStreamLoggerModule.Logger[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ScriptBlock --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The script block to execute.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Loggers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Loggers</maml:name> <maml:description> <maml:para>The loggers to send log events to. If no loggers are configured, a console logger with minimum log level information will be used.</maml:para> </maml:description> <command:parameterValue required="true">Logger[]</command:parameterValue> <dev:type> <maml:name>PSStreamLoggerModule.Logger[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExecutionMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecutionMode</maml:name> <maml:description> <maml:para>The mode to execute the script block in. NewScope executes the script block in a new scope (default), CurrentScope executes it in the current scope (in the same scope this Cmdlet is executed from) and NewRunspace executes it in a new PowerShell runspace.</maml:para> <maml:para>Possible values: NewScope, CurrentScope, NewRunspace</maml:para> </maml:description> <command:parameterValue required="true">ExecutionMode</command:parameterValue> <dev:type> <maml:name>PSStreamLoggerModule.ExecutionMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NewScope</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NewScope</command:parameterValue> <command:parameterValue required="false" variableLength="false">CurrentScope</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewRunspace</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DisableStreamConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableStreamConfiguration</maml:name> <maml:description> <maml:para>Disable the automatic PowerShell stream configuration. based on the lowest log level.</maml:para> <maml:para>By default the PowerShell streams are configured based on the lowest log level across all loggers.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: New-ConsoleLogger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-ConsoleLogger</command:name> <command:verb>New</command:verb> <command:noun>ConsoleLogger</command:noun> <maml:description> <maml:para>Creates a new console logger that writes log events to the console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A logger based on the Serilog.Sinks.Console that writes log events to the console via standard output.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ConsoleLogger</maml:name> <!-- Parameter: ExpressionTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpressionTemplate</maml:name> <maml:description> <maml:para>The expression template (Serilog.Expressions) defines how log events are converted to text.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate.</maml:para> <maml:para>More examples: https://nblumhardt.com/2021/06/customize-serilog-text-output/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[{@t:yyyy-MM-dd HH:mm:ss.fffzz} {@l:u3}] {@m:lj} {PSErrorDetails}</dev:defaultValue> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ExpressionTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpressionTemplate</maml:name> <maml:description> <maml:para>The expression template (Serilog.Expressions) defines how log events are converted to text.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate.</maml:para> <maml:para>More examples: https://nblumhardt.com/2021/06/customize-serilog-text-output/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[{@t:yyyy-MM-dd HH:mm:ss.fffzz} {@l:u3}] {@m:lj} {PSErrorDetails}</dev:defaultValue> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Logger --> <command:returnValue> <dev:type> <maml:name>PSStreamLoggerModule.Logger</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: New-EventLogLogger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-EventLogLogger</command:name> <command:verb>New</command:verb> <command:noun>EventLogLogger</command:noun> <maml:description> <maml:para>Creates a new event log logger that writes log events to a Windows EventLog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A logger based on the Serilog.Sinks.EventLog that writes log events to a Windows EventLog.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-EventLogLogger</maml:name> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The event source that is typically name of the application/program writing log events to the event log.</maml:para> <maml:para>The logger will not create the event source. The event source has to exist for the logger to work (can be created with elevated privileges using New-EventLog).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventIdProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventIdProvider</maml:name> <maml:description> <maml:para>A script block that provides the event ID for each log event based on the log event's properties.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpressionTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpressionTemplate</maml:name> <maml:description> <maml:para>The expression template (Serilog.Expressions) defines how log events are converted to text.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate.</maml:para> <maml:para>More examples: https://nblumhardt.com/2021/06/customize-serilog-text-output/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>{@m:lj} {PSErrorDetails}</dev:defaultValue> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The name of the target event log to which log events are written.</maml:para> <maml:para>The logger will not create the event log. The event log has to exist for the logger to work (can be created with elevated privileges using New-EventLog).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The event source that is typically name of the application/program writing log events to the event log.</maml:para> <maml:para>The logger will not create the event source. The event source has to exist for the logger to work (can be created with elevated privileges using New-EventLog).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The name of the target event log to which log events are written.</maml:para> <maml:para>The logger will not create the event log. The event log has to exist for the logger to work (can be created with elevated privileges using New-EventLog).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventIdProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventIdProvider</maml:name> <maml:description> <maml:para>A script block that provides the event ID for each log event based on the log event's properties.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpressionTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpressionTemplate</maml:name> <maml:description> <maml:para>The expression template (Serilog.Expressions) defines how log events are converted to text.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate.</maml:para> <maml:para>More examples: https://nblumhardt.com/2021/06/customize-serilog-text-output/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>{@m:lj} {PSErrorDetails}</dev:defaultValue> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Logger --> <command:returnValue> <dev:type> <maml:name>PSStreamLoggerModule.Logger</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: New-FileLogger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-FileLogger</command:name> <command:verb>New</command:verb> <command:noun>FileLogger</command:noun> <maml:description> <maml:para>Creates a new file logger that writes log events to plain text files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A logger based on the Serilog.Sinks.File that writes log events to plain text files.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-FileLogger</maml:name> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The log file path (absolute or relative).</maml:para> <maml:para>For relative paths the current working directory will be used as the root path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpressionTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpressionTemplate</maml:name> <maml:description> <maml:para>The expression template (Serilog.Expressions) defines how log events are converted to text.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate.</maml:para> <maml:para>More examples: https://nblumhardt.com/2021/06/customize-serilog-text-output/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[{@t:yyyy-MM-dd HH:mm:ss.fffzz} {@l:u3}] {@m:lj} {PSErrorDetails}</dev:defaultValue> </command:parameter> <!-- Parameter: FileSizeLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileSizeLimit</maml:name> <maml:description> <maml:para>The file size limit in bytes (default = 1GB).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1073741824</dev:defaultValue> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: RetainedFileCountLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetainedFileCountLimit</maml:name> <maml:description> <maml:para>The maximum number of log files to keep if rolling file is used. Older log files will automatically be cleaned up.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>31</dev:defaultValue> </command:parameter> <!-- Parameter: RollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RollingInterval</maml:name> <maml:description> <maml:para>The rolling time-based interval to use for the log file.</maml:para> <maml:para>Infinite = File will not roll (no new log file will be created) on a time-based interval.</maml:para> <maml:para>Possible values: Infinite, Year, Month, Day, Hour, Minute</maml:para> </maml:description> <command:parameterValue required="true">RollingInterval</command:parameterValue> <dev:type> <maml:name>Serilog.RollingInterval</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Infinite</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Infinite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Year</command:parameterValue> <command:parameterValue required="false" variableLength="false">Month</command:parameterValue> <command:parameterValue required="false" variableLength="false">Day</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hour</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minute</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: RollOnFileSizeLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RollOnFileSizeLimit</maml:name> <maml:description> <maml:para>Whether or not to create a new log file when the file size limit is reached.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The log file path (absolute or relative).</maml:para> <maml:para>For relative paths the current working directory will be used as the root path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileSizeLimit</maml:name> <maml:description> <maml:para>The file size limit in bytes (default = 1GB).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1073741824</dev:defaultValue> </command:parameter> <!-- Parameter: RetainedFileCountLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetainedFileCountLimit</maml:name> <maml:description> <maml:para>The maximum number of log files to keep if rolling file is used. Older log files will automatically be cleaned up.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>31</dev:defaultValue> </command:parameter> <!-- Parameter: RollOnFileSizeLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RollOnFileSizeLimit</maml:name> <maml:description> <maml:para>Whether or not to create a new log file when the file size limit is reached.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RollingInterval</maml:name> <maml:description> <maml:para>The rolling time-based interval to use for the log file.</maml:para> <maml:para>Infinite = File will not roll (no new log file will be created) on a time-based interval.</maml:para> <maml:para>Possible values: Infinite, Year, Month, Day, Hour, Minute</maml:para> </maml:description> <command:parameterValue required="true">RollingInterval</command:parameterValue> <dev:type> <maml:name>Serilog.RollingInterval</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Infinite</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Infinite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Year</command:parameterValue> <command:parameterValue required="false" variableLength="false">Month</command:parameterValue> <command:parameterValue required="false" variableLength="false">Day</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hour</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minute</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExpressionTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpressionTemplate</maml:name> <maml:description> <maml:para>The expression template (Serilog.Expressions) defines how log events are converted to text.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate.</maml:para> <maml:para>More examples: https://nblumhardt.com/2021/06/customize-serilog-text-output/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[{@t:yyyy-MM-dd HH:mm:ss.fffzz} {@l:u3}] {@m:lj} {PSErrorDetails}</dev:defaultValue> </command:parameter> <!-- Parameter: MinimumLogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLogLevel</maml:name> <maml:description> <maml:para>The minimum log level this logger should include.</maml:para> <maml:para>Possible values ordered by lowest to highest: Verbose, Debug, Information, Warning, Error, Fatal.</maml:para> <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para> </maml:description> <command:parameterValue required="true">LogEventLevel</command:parameterValue> <dev:type> <maml:name>Serilog.Events.LogEventLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Information</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterIncludeOnlyExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterIncludeOnlyExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should include.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterExcludeExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterExcludeExpression</maml:name> <maml:description> <maml:para>An expression-based filter (Serilog.Expressions) that defines which log events this logger should exclude.</maml:para> <maml:para>For more information and examples go to: https://github.com/serilog/serilog-expressions#filtering-example.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Logger --> <command:returnValue> <dev:type> <maml:name>PSStreamLoggerModule.Logger</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Out-PSStreamLogger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Out-PSStreamLogger</command:name> <command:verb>Out</command:verb> <command:noun>PSStreamLogger</command:noun> <maml:description> <maml:para>Sends redirected stream data to the DataRecordLogger.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is internally used by the Invoke-CommandWithLogging command if one of the execution modes NewScope or CurrentScope are used to leverage stream redirection to send stream data to the DataRecordLogger through this command.</maml:para> <maml:para>Output is passed through.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Out-PSStreamLogger</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>PSObject to send to the DataRecordLogger.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataRecordLogger --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DataRecordLogger</maml:name> <maml:description> <maml:para>The DataRecordLogger that will process PSObjects received.</maml:para> <maml:para>PSObjects of type Verbose-, Debug-, Information-, Warning- and ErrorRecord will be processed as log events by the DataRecordLogger while any other object will be passed through.</maml:para> </maml:description> <command:parameterValue required="true">DataRecordLogger</command:parameterValue> <dev:type> <maml:name>PSStreamLoggerModule.DataRecordLogger</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>PSObject to send to the DataRecordLogger.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataRecordLogger --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DataRecordLogger</maml:name> <maml:description> <maml:para>The DataRecordLogger that will process PSObjects received.</maml:para> <maml:para>PSObjects of type Verbose-, Debug-, Information-, Warning- and ErrorRecord will be processed as log events by the DataRecordLogger while any other object will be passed through.</maml:para> </maml:description> <command:parameterValue required="true">DataRecordLogger</command:parameterValue> <dev:type> <maml:name>PSStreamLoggerModule.DataRecordLogger</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSObject to send to the DataRecordLogger.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> </helpItems> |