en-US/HybridWorkerToolkit.psm1-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <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--> <command:details> <command:name>New-HybridWorkerRunbookLogEntry</command:name> <maml:description> <maml:para>Create a structured event log entry on the Azure Automation Hybrid Worker.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>HybridWorkerRunbookLogEntry</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a structured event log entry on the Azure Automation Hybrid Worker. This function can be called within an Azure Automation runbook when executed on a Hybrid Worker. It logs runbook related status messages on Windows Event Log on the Hybrid Worker.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HybridWorkerRunbookLogEntry</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>LogName</maml:name> <maml:description> <maml:para>Specify the event log name to be written to. Only administrative Windows event logs are supported. Operational logs are not supported. This is an optional parameter, when not specified, the Application log is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>Application</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specify the event log Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Level</maml:name> <maml:description> <maml:para>Specify the event log level. Possible values are: Information, Warning, Error. This is an optional parameter. The default value is "Information" when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>Information</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specify the event log source. Possible values:'AzureAutomation Job Verbose', 'AzureAutomation Job Status', 'AzureAutomation Job Result','AzureAutomation Job Process'. This is an optional parameter, If not specified, the event log source will be 'AzureAutomation Job Status'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>AzureAutomation Job Status</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Message</maml:name> <maml:description> <maml:para>Specify the event message to be written to the Event Log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>LogName</maml:name> <maml:description> <maml:para>Specify the event log name to be written to. Only administrative Windows event logs are supported. Operational logs are not supported. This is an optional parameter, when not specified, the Application log is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>Application</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specify the event log Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Level</maml:name> <maml:description> <maml:para>Specify the event log level. Possible values are: Information, Warning, Error. This is an optional parameter. The default value is "Information" when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>Information</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specify the event log source. Possible values:'AzureAutomation Job Verbose', 'AzureAutomation Job Status', 'AzureAutomation Job Result','AzureAutomation Job Process'. This is an optional parameter, If not specified, the event log source will be 'AzureAutomation Job Status'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>AzureAutomation Job Status</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Message</maml:name> <maml:description> <maml:para>Specify the event message to be written to the Event Log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LogHybridWorkerConfig</maml:name> <maml:description> <maml:para>Specify if the Hybrid Worker configuration should also be logged in the event log entry. when set to $true, the following information will also be logged: - Hybrid Worker Version - Microsoft Monitoring Agent Version - Microsoft Monitoring Agent Install Path - Microsoft Monitoring Agent Proxy URL - Hybrid Worker server System-wide Proxy server address - Microsoft OMS Workspace ID Note: When -LogHybridWorkerConfig is set to $true, -LogMinimum must be set to false.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para>Specify additional event parameters to be logged with the event.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LogMinimum</maml:name> <maml:description> <maml:para>Specify if only the minimum information (JobId) are logged. Note: When LogMinimum is set to $true, -LogHybridWorkerConfig must be set to false.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-HybridWorkerRunbookLogEntry -Id 888 -Message "This is a test message logged from hybrid worker within a runbook."</dev:code> <dev:remarks> <maml:para>Write an event with Id 888 with the default event log destination (Application log) and default level (Information).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-HybridWorkerRunbookLogEntry -LogName System -Id 888 -Level 'Error' -Source 'AzureAutomation Job Process' -LogHybridWorkerConfig $true -Message "This is an error test message logged from hybrid worker within a runbook."</dev:code> <dev:remarks> <maml:para>Write an error event with Id 888 and source 'AzureAutomation Job Process' to the System log with additional information about Hybrid Worker configuration.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$AdditionalInfo = @('Additional parameter #1', 'Additional parameter #2') New-HybridWorkerRunbookLogEntry -LogName System -Id 888 -Level 'Error' -Source 'AzureAutomation Job Process' -LogHybridWorkerConfig $true -Message "This is an error test message logged from hybrid worker within a runbook." -AdditionalParameters $AdditionalInfo</dev:code> <dev:remarks> <maml:para>Write an error event with Id 888 and source 'AzureAutomation Job Process' to the System log with additional information about Hybrid Worker configuration, as well as user-specified additional information.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-HybridWorkerRunbookLogEntry -LogName System -Id 888 -Level 'Error' -Source 'AzureAutomation Job Process' -LogMinimum $true -Message "This is an error test message logged from hybrid worker within a runbook."</dev:code> <dev:remarks> <maml:para>Write an error event with Id 888 and source 'AzureAutomation Job Process' to the System log with only the Job Id (Minimum information).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Module: HybridWorkerToolkit Version: 0.0 --> <!--All Commands--> <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--> <command:details> <command:name>Get-HybridWorkerConfiguration</command:name> <maml:description> <maml:para>Get the Hybrid Worker and the Microsoft Monitoring Agent configuration</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HybridWorkerConfiguration</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get the Hybrid Worker and the Microsoft Monitoring Agent configuration. a hashtable is returned with various configuration properties of Hybrid Worker and Microsoft Monitoring Agent. It retrieves the following information: - Hybrid Worker Group name - Automation Account Id - Machine Id - Computer Name - MMA install root - PowerShell version - Hybrid Worker version - System-wide Proxy server address - MMA version - MMA Proxy URL - MMA Proxy user name - MMA connected OMS workspace Id Note: some properties are only returned when this function is called within a Azure automation runbook executed on Hybrid Workers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-HybridWorkerConfiguration</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <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--> <command:details> <command:name>Get-HybridWorkerJobRuntimeInfo</command:name> <maml:description> <maml:para>Get the runbook runtime information when executed on a Hybrid Worker.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HybridWorkerJobRuntimeInfo</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get the runbook runtime information when executed on a Hybrid Worker. It retrieves the following information: - Runbook job ID - Sandbox Id - Process Id - Automation Asset End Point - PSModulePath environment variable - Current User name - Log Activity Trace - Current Working Directory - Runbook type - Runbook name - Azure Automation account name - Azure Resource Group name - Azure subscription Id - Time taken to start runbook in seconds</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-HybridWorkerJobRuntimeInfo</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> </helpItems> |