UniversalDashboard.Community/en-US/UniversalDashboard.Community-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-UDElement</command:name> <command:verb>Add</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Adds a new element to the specified parent.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new element to the specified parent. This will add the element after existing children.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content to append to the parent element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentId</maml:name> <maml:Description> <maml:para>The ID of the parent element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content to append to the parent element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentId</maml:name> <maml:Description> <maml:para>The ID of the parent element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UDElement -Id "message" -Attributes @{ type = "text" value = '' placeholder = "Type a chat message" } PS C:\> Add-UDElement -ParentId "chatroom" -Content { $message } -Broadcast</dev:code> <dev:remarks> <maml:para>Adds a message element the "chatroom" parent element. It will add this element to all connected clients.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-UDCache</command:name> <command:verb>Clear</command:verb> <command:noun>UDCache</command:noun> <maml:description> <maml:para>Clears the Universal Dashboard cache scope.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the Universal Dashboard cache scope. Existing $Cache variables will no longer be present.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-UDCache</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Clear-UDCache</dev:code> <dev:remarks> <maml:para>Clears the UD cache.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-UDElement</command:name> <command:verb>Clear</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Clears the children of the specified element.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the children of the specified element.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to clear.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to clear.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Clear-UDElement -Id "chatroom"</dev:code> <dev:remarks> <maml:para>Clears the chatroom element of all children.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertTo-JsonEx</command:name> <command:verb>ConvertTo</command:verb> <command:noun>JsonEx</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-JsonEx</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{Fill InputObject Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsArray</maml:name> <maml:Description> <maml:para>{{Fill AsArray Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Compress</maml:name> <maml:Description> <maml:para>{{Fill Compress Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:Description> <maml:para>{{Fill Depth Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnumsAsStrings</maml:name> <maml:Description> <maml:para>{{Fill EnumsAsStrings Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsArray</maml:name> <maml:Description> <maml:para>{{Fill AsArray Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Compress</maml:name> <maml:Description> <maml:para>{{Fill Compress Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:Description> <maml:para>{{Fill Depth Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnumsAsStrings</maml:name> <maml:Description> <maml:para>{{Fill EnumsAsStrings Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{Fill InputObject Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://go.microsoft.com/fwlink/?LinkID=217032</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-UDLogging</command:name> <command:verb>Disable</command:verb> <command:noun>UDLogging</command:noun> <maml:description> <maml:para>Disables logging for Universal Dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disables logging for Universal Dashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-UDLogging</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Disable-UDLogging</dev:code> <dev:remarks> <maml:para>Disables logging for Universal Dashboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-UDLogging</command:name> <command:verb>Enable</command:verb> <command:noun>UDLogging</command:noun> <maml:description> <maml:para>Enables logging for Universal Dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enables logging for Universal Dashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-UDLogging</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Console</maml:name> <maml:Description> <maml:para>Logs to the console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Logs to the specified file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The log level to log. Will log the level specified and above.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Console</maml:name> <maml:Description> <maml:para>Logs to the console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Logs to the specified file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The log level to log. Will log the level specified and above.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Enable-UDLogging -Level Debug -FilePath .\log.txt -Console</dev:code> <dev:remarks> <maml:para>Outputs Debug messages and above to the log.txt file and the console.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDContentType</command:name> <command:verb>Get</command:verb> <command:noun>UDContentType</command:noun> <maml:description> <maml:para>Returns the content-type of an HTTP request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the content-type of an HTTP request. This cmdlet should be used within Endpoint script blocks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDContentType</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UDContentType</dev:code> <dev:remarks> <maml:para>Returns the content-type of the HTTP request.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDCookie</command:name> <command:verb>Get</command:verb> <command:noun>UDCookie</command:noun> <maml:description> <maml:para>Gets a cookie from the HTTP request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a cookie from the HTTP request. This cmdlet should be called within endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDCookie</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDInput -Title "Get a cookie" -Endpoint { param() $Cookie = Get-UDCookie -Name "MyCookie" New-UDInputAction -Toast $Cookie.Value }</dev:code> <dev:remarks> <maml:para>Returns the value of MyCookie as a Toast when the user clicks the submit button.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDDashboard</command:name> <command:verb>Get</command:verb> <command:noun>UDDashboard</command:noun> <maml:description> <maml:para>Returns dashboards started with Start-UDDashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns dashboards started with Start-UDDashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UDDashboard</dev:code> <dev:remarks> <maml:para>Returns all dashboards stared with Start-UDDashboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-UDDashboard -Name "MyDashboard"</dev:code> <dev:remarks> <maml:para>Returns a dashboard named "MyDashboard" started with Start-UDDashboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDElement</command:name> <command:verb>Get</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Returns an element from the client.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an element from the client. This cmdlet can be used to return changes in state, like the value of a text box.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDElement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to get.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to get.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $txtMessage = Get-UDElement -Id "message" PS C:\> $Message = "$(Get-Date) $User : $($txtMessage.Attributes['value'])"</dev:code> <dev:remarks> <maml:para>Returns the "message" element from the client and gets the value of the text box and formats it into the message string.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDLicense</command:name> <command:verb>Get</command:verb> <command:noun>UDLicense</command:noun> <maml:description> <maml:para>Gets the installed license</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the installed license</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDLicense</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-License</dev:code> <dev:remarks> <maml:para>Gets the installed license</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDRestApi</command:name> <command:verb>Get</command:verb> <command:noun>UDRestApi</command:noun> <maml:description> <maml:para>Returns all running REST API servers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all running REST API servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDRestApi</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the REST API server to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the REST API server to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UDRestApi -Name "RestApi1"</dev:code> <dev:remarks> <maml:para>Returns the REST API server named RestApi1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDTheme</command:name> <command:verb>Get</command:verb> <command:noun>UDTheme</command:noun> <maml:description> <maml:para>Returns the pre-defined themes for Universal Dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the pre-defined themes for Universal Dashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDTheme</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the theme to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the theme to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $Themes = Get-UDTheme</dev:code> <dev:remarks> <maml:para>Returns all the themes for Universal Dashboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Theme = Get-UDTheme -Name 'Azure'</dev:code> <dev:remarks> <maml:para>Returns the Azure theme for Universal Dashboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Grant-UDJsonWebToken</command:name> <command:verb>Grant</command:verb> <command:noun>UDJsonWebToken</command:noun> <maml:description> <maml:para>Grants a JSON web token for the specified user or application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Grants a JSON web token for the specified user. You can adjust the JSON web token parameters in addition to specifying the user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Grant-UDJsonWebToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>The name of the application granted the token.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Audience</maml:name> <maml:Description> <maml:para>The aud (audience) claim identifies the recipients that the JWT is intended for. See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.3</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Expiry</maml:name> <maml:Description> <maml:para>The exp (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.4</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>The iss (issuer) claim identifies the principal that issued the JWT. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.1</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SigningKey</maml:name> <maml:Description> <maml:para>The secret key used to sign the web token. This should be treated as a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Subject</maml:name> <maml:Description> <maml:para>The sub (subject) claim identifies the principal that is the subject of the JWT. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Grant-UDJsonWebToken</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Audience</maml:name> <maml:Description> <maml:para>The aud (audience) claim identifies the recipients that the JWT is intended for. See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.3</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Expiry</maml:name> <maml:Description> <maml:para>The exp (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.4</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>The iss (issuer) claim identifies the principal that issued the JWT. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.1</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SigningKey</maml:name> <maml:Description> <maml:para>The secret key used to sign the web token. This should be treated as a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Subject</maml:name> <maml:Description> <maml:para>The sub (subject) claim identifies the principal that is the subject of the JWT. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>The user name of the user the token is granted to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>The name of the application granted the token.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Audience</maml:name> <maml:Description> <maml:para>The aud (audience) claim identifies the recipients that the JWT is intended for. See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.3</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Expiry</maml:name> <maml:Description> <maml:para>The exp (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.4</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>The iss (issuer) claim identifies the principal that issued the JWT. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.1</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SigningKey</maml:name> <maml:Description> <maml:para>The secret key used to sign the web token. This should be treated as a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Subject</maml:name> <maml:Description> <maml:para>The sub (subject) claim identifies the principal that is the subject of the JWT. </maml:para> <maml:para>See: https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#rfc.section.4.1.2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>The user name of the user the token is granted to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $Token = Grant-UDJsonWebToken -UserName "Adam" PS C:\> Invoke-RestMethod http://localhost/api/resource -Headers @{ Authorization = "Bearer $Token"}</dev:code> <dev:remarks> <maml:para>Creates a JSON web token for Adam and then uses that token to access a protected resource on the API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Hide-UDModal</command:name> <command:verb>Hide</command:verb> <command:noun>UDModal</command:noun> <maml:description> <maml:para>Hides a modal shown with Show-UDModal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hides a modal shown with Show-UDModal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Hide-UDModal</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Hide-UDModal</dev:code> <dev:remarks> <maml:para>Hides a modal shown with Show-UDModal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Hide-UDToast</command:name> <command:verb>Hide</command:verb> <command:noun>UDToast</command:noun> <maml:description> <maml:para>Hides a toast message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hides a toast mesage.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Hide-UDToast</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the toast message to hide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the toast message to hide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Hide-UDToast -Id "ToastMessage"</dev:code> <dev:remarks> <maml:para>Hides the toast message specified by the ID "ToastMessage"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UDEvent</command:name> <command:verb>Invoke</command:verb> <command:noun>UDEvent</command:noun> <maml:description> <maml:para>Performs a clientside "click" event on the specified id, if the element is clickable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Performs a clientside "click" event on the specified id, if the element is clickable.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UDEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id of the event to trigger.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>event</maml:name> <maml:Description> <maml:para>The typeof event to trigger</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">onClick</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id of the event to trigger.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>event</maml:name> <maml:Description> <maml:para>The typeof event to trigger</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-UDEvent -id "someid" -event "onClick"</dev:code> <dev:remarks> <maml:para>Performs a clientside "click" event on the specified id, if the element is clickable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UDJavaScript</command:name> <command:verb>Invoke</command:verb> <command:noun>UDJavaScript</command:noun> <maml:description> <maml:para>Execute javascript on client.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Executes specified javascript on the client.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UDJavaScript</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JavaScript</maml:name> <maml:Description> <maml:para>The javascript "codeblock" in string format.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JavaScript</maml:name> <maml:Description> <maml:para>The javascript "codeblock" in string format.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-UDJavaScript -JavaScript 'alert("hello world");'</dev:code> <dev:remarks> <maml:para>Executes the "alert" function of Javascript on the client, and alerts the user with "hello world".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UDRedirect</command:name> <command:verb>Invoke</command:verb> <command:noun>UDRedirect</command:noun> <maml:description> <maml:para>Redirects a user to a URL.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Redirects a user to a URL. This cmdlet can be called from any endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UDRedirect</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OpenInNewWindow</maml:name> <maml:Description> <maml:para>Opens the URL in a new window.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL to redirect the user to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OpenInNewWindow</maml:name> <maml:Description> <maml:para>Opens the URL in a new window.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL to redirect the user to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------------- Redirect to Google ----------------------</maml:title> <dev:code>New-UDButton -Text "Redirect to Google" -OnClick { Invoke-UDRedirect -Url "https://www.google.com" }</dev:code> <dev:remarks> <maml:para>Redirects the user to Google.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------- Open in a new tab or window -----------------</maml:title> <dev:code>New-UDButton -Text "Redirect to Google" -OnClick { Invoke-UDRedirect -Url "https://www.google.com" -OpenInNewWindow }</dev:code> <dev:remarks> <maml:para>Redirects the user to Google.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDColumn</command:name> <command:verb>New</command:verb> <command:noun>UDColumn</command:noun> <maml:description> <maml:para>Creates a new column in the dashboard. This should be called within a New-UDRow's content or endpoint block.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new column in the dashboard. This should be called within a New-UDRow. Columns can be size 1-12. Size 12 would span the entire width of the page. If you had 12 size 1 columns, each would take up 1/12 of the page and they would be equally spaced along the row.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDColumn</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether this column should auto-refresh. The default interval is every 5 seconds.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The endpoint to call to generate the content of this column. This is mutually exclusive with Content.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the column. This is the ID set in the HTML markup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LargeOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on large screens. Large screens are over 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LargeSize</maml:name> <maml:Description> <maml:para>The size of this column on large screens. Large screens are over 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MediumOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on medium screens. Medium screens are over 600px and less than 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MediumSize</maml:name> <maml:Description> <maml:para>The size of this column on medium screens. Medium screens are over 600px and less than 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>How often this column refreshes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SmallOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on small screens. Small screens are under 600px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Size"> <maml:name>SmallSize</maml:name> <maml:Description> <maml:para>The size of this column on small screens. Small screens are under 600px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDColumn</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the column. This can be one or more controls. It can also be other another row of columns.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the column. This is the ID set in the HTML markup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LargeOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on large screens. Large screens are over 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LargeSize</maml:name> <maml:Description> <maml:para>The size of this column on large screens. Large screens are over 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MediumOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on medium screens. Medium screens are over 600px and less than 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MediumSize</maml:name> <maml:Description> <maml:para>The size of this column on medium screens. Medium screens are over 600px and less than 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SmallOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on small screens. Small screens are under 600px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Size"> <maml:name>SmallSize</maml:name> <maml:Description> <maml:para>The size of this column on small screens. Small screens are under 600px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether this column should auto-refresh. The default interval is every 5 seconds.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the column. This can be one or more controls. It can also be other another row of columns.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The endpoint to call to generate the content of this column. This is mutually exclusive with Content.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the column. This is the ID set in the HTML markup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LargeOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on large screens. Large screens are over 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LargeSize</maml:name> <maml:Description> <maml:para>The size of this column on large screens. Large screens are over 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MediumOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on medium screens. Medium screens are over 600px and less than 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MediumSize</maml:name> <maml:Description> <maml:para>The size of this column on medium screens. Medium screens are over 600px and less than 992px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>How often this column refreshes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SmallOffset</maml:name> <maml:Description> <maml:para>The number of columns to offset this column on small screens. Small screens are under 600px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Size"> <maml:name>SmallSize</maml:name> <maml:Description> <maml:para>The size of this column on small screens. Small screens are under 600px wide.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDRow -Columns { New-UDColumn -Size 12 -Content { New-UDChart ... } }</dev:code> <dev:remarks> <maml:para>Creats a new row with a column that spans the entire page.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-UDRow -Columns { New-UDColumn -Size 4 -Content { New-UDChart ... } New-UDColumn -Size 4 -Content { New-UDChart ... } New-UDColumn -Size 4 -Content { New-UDChart ... } }</dev:code> <dev:remarks> <maml:para>Creates a new row with 3 columns that take up 1/3 of the page width each.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDDashboard</command:name> <command:verb>New</command:verb> <command:noun>UDDashboard</command:noun> <maml:description> <maml:para>Creates a new dashboard. The result of this cmdlet should be passed to Start-UDDashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new dashboard. The result of this cmdlet should be passed to Start-UDDashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>Content of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CyclePages</maml:name> <maml:Description> <maml:para>Changes pages in the dashboard automatically.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CyclePagesInterval</maml:name> <maml:Description> <maml:para>The number of seconds to wait on each page before changing to the next page. Defaults to 10 seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointInitialization</maml:name> <maml:Description> <maml:para>The initial session state for endpoints of this dashboard. Use New-UDEndpointInitialization to create an object for this parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue> <dev:type> <maml:name>InitialSessionState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>Font color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>Configuration options for the footer. Use New-UDFooter to create the object for these options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Footer</command:parameterValue> <dev:type> <maml:name>Footer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoLocation</maml:name> <maml:Description> <maml:para>Enables GeoLocation support for the dashboard. A $Location variable will be defined in all endpoints when this is enabled. When a user allows the dashboard to get their location, you will have access to the latitude, longitude, heading and speed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdleTimeout</maml:name> <maml:Description> <maml:para>The amount of time a session can be idle before it times out. This defaults to 25 minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Color"> <maml:name>NavBarColor</maml:name> <maml:Description> <maml:para>Navigation bar and footer color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavBarFontColor</maml:name> <maml:Description> <maml:para>Navigation bar and footer font color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavBarLogo</maml:name> <maml:Description> <maml:para>A logo to use within the navbar. Use New-UDImage to create this logo.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Element</command:parameterValue> <dev:type> <maml:name>Element</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavbarLinks</maml:name> <maml:Description> <maml:para>Links to present on the dashboard. Use New-UDLink to create links.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Navigation</maml:name> <maml:Description> <maml:para>{{Fill Navigation Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SideNav</command:parameterValue> <dev:type> <maml:name>SideNav</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scripts</maml:name> <maml:Description> <maml:para>Additional scripts to include with the dashboard. These scripts are not copied but just referenced in the output HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stylesheets</maml:name> <maml:Description> <maml:para>Additional stylesheets to include with the dashboard. These stylesheets are not copied but just referenced in the output HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Theme</maml:name> <maml:Description> <maml:para>The theme to use with this dashboard. This can be a predefined theme supplied by Get-UDTheme or a custom theme created with New-UDTheme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Theme</command:parameterValue> <dev:type> <maml:name>Theme</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Title for the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CyclePages</maml:name> <maml:Description> <maml:para>Changes pages in the dashboard automatically.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CyclePagesInterval</maml:name> <maml:Description> <maml:para>The number of seconds to wait on each page before changing to the next page. Defaults to 10 seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointInitialization</maml:name> <maml:Description> <maml:para>The initial session state for endpoints of this dashboard. Use New-UDEndpointInitialization to create an object for this parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue> <dev:type> <maml:name>InitialSessionState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>Font color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>Configuration options for the footer. Use New-UDFooter to create the object for these options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Footer</command:parameterValue> <dev:type> <maml:name>Footer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoLocation</maml:name> <maml:Description> <maml:para>Enables GeoLocation support for the dashboard. A $Location variable will be defined in all endpoints when this is enabled. When a user allows the dashboard to get their location, you will have access to the latitude, longitude, heading and speed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdleTimeout</maml:name> <maml:Description> <maml:para>The amount of time a session can be idle before it times out. This defaults to 25 minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Color"> <maml:name>NavBarColor</maml:name> <maml:Description> <maml:para>Navigation bar and footer color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavBarFontColor</maml:name> <maml:Description> <maml:para>Navigation bar and footer font color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavBarLogo</maml:name> <maml:Description> <maml:para>A logo to use within the navbar. Use New-UDImage to create this logo.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Element</command:parameterValue> <dev:type> <maml:name>Element</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavbarLinks</maml:name> <maml:Description> <maml:para>Links to present on the dashboard. Use New-UDLink to create links.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Navigation</maml:name> <maml:Description> <maml:para>{{Fill Navigation Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SideNav</command:parameterValue> <dev:type> <maml:name>SideNav</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pages</maml:name> <maml:Description> <maml:para>An array of pages to display in a multi-page dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page[]</command:parameterValue> <dev:type> <maml:name>Page[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scripts</maml:name> <maml:Description> <maml:para>Additional scripts to include with the dashboard. These scripts are not copied but just referenced in the output HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stylesheets</maml:name> <maml:Description> <maml:para>Additional stylesheets to include with the dashboard. These stylesheets are not copied but just referenced in the output HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Theme</maml:name> <maml:Description> <maml:para>The theme to use with this dashboard. This can be a predefined theme supplied by Get-UDTheme or a custom theme created with New-UDTheme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Theme</command:parameterValue> <dev:type> <maml:name>Theme</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Title for the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>Content of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CyclePages</maml:name> <maml:Description> <maml:para>Changes pages in the dashboard automatically.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CyclePagesInterval</maml:name> <maml:Description> <maml:para>The number of seconds to wait on each page before changing to the next page. Defaults to 10 seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointInitialization</maml:name> <maml:Description> <maml:para>The initial session state for endpoints of this dashboard. Use New-UDEndpointInitialization to create an object for this parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue> <dev:type> <maml:name>InitialSessionState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>Font color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>Configuration options for the footer. Use New-UDFooter to create the object for these options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Footer</command:parameterValue> <dev:type> <maml:name>Footer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoLocation</maml:name> <maml:Description> <maml:para>Enables GeoLocation support for the dashboard. A $Location variable will be defined in all endpoints when this is enabled. When a user allows the dashboard to get their location, you will have access to the latitude, longitude, heading and speed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdleTimeout</maml:name> <maml:Description> <maml:para>The amount of time a session can be idle before it times out. This defaults to 25 minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Color"> <maml:name>NavBarColor</maml:name> <maml:Description> <maml:para>Navigation bar and footer color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavBarFontColor</maml:name> <maml:Description> <maml:para>Navigation bar and footer font color.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavBarLogo</maml:name> <maml:Description> <maml:para>A logo to use within the navbar. Use New-UDImage to create this logo.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Element</command:parameterValue> <dev:type> <maml:name>Element</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NavbarLinks</maml:name> <maml:Description> <maml:para>Links to present on the dashboard. Use New-UDLink to create links.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Navigation</maml:name> <maml:Description> <maml:para>{{Fill Navigation Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SideNav</command:parameterValue> <dev:type> <maml:name>SideNav</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pages</maml:name> <maml:Description> <maml:para>An array of pages to display in a multi-page dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page[]</command:parameterValue> <dev:type> <maml:name>Page[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scripts</maml:name> <maml:Description> <maml:para>Additional scripts to include with the dashboard. These scripts are not copied but just referenced in the output HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stylesheets</maml:name> <maml:Description> <maml:para>Additional stylesheets to include with the dashboard. These stylesheets are not copied but just referenced in the output HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Theme</maml:name> <maml:Description> <maml:para>The theme to use with this dashboard. This can be a predefined theme supplied by Get-UDTheme or a custom theme created with New-UDTheme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Theme</command:parameterValue> <dev:type> <maml:name>Theme</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Title for the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $Dashboard = New-UDDashboard -Color "blue" -Content { New-UDChart ... }</dev:code> <dev:remarks> <maml:para>Creates a new dashboard with a blue color that contains a chart.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Start-UDDashboard -Dashboard { New-UDDashboard -Color "blue" -Content { New-UDChart ... } }</dev:code> <dev:remarks> <maml:para>Creates a new dashboard with a blue color that contains a chart and starts it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $Page1 = New-UDPage -Name "Home" -Content { New-Chart... } PS C:\> $Page2 = New-UDPage -Name "Cards" -Content { New-Card... } PS C:\> $Dashboard = New-UDDashboard -Color "blue" -Pages @($Page1, $Page2)</dev:code> <dev:remarks> <maml:para>Creates a multi-page dashboard. The will show a navigation pane on the left side of the dashboard to navigate to different pages.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDElement</command:name> <command:verb>New</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Create new HTML and JavaScript elements.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create new HTML and JavaScript elements. Create static and dynamic components.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:Description> <maml:para>Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>A hashtable of attributes that will be set on the HTML tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether to auto refresh the contents of this element.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The static content for this HTML node. This can be a string or another element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An endpoint that is called to load the content of this element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID for this element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnMount</maml:name> <maml:Description> <maml:para>{{Fill OnMount Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>The refresh interval on which to reload the content of this element, in seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>The HTML tag to render.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:Description> <maml:para>Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether to auto refresh the contents of this element.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentName</maml:name> <maml:Description> <maml:para>The JavaScript component to include.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An endpoint that is called to load the content of this element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID for this element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JavaScriptPath</maml:name> <maml:Description> <maml:para>Path to a JavaScript file that contains the JavaScript component to load.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>The name of the JavaScript module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>Properties to pass into the JavaScript component.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>The refresh interval on which to reload the content of this element, in seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:Description> <maml:para>Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>A hashtable of attributes that will be set on the HTML tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether to auto refresh the contents of this element.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentName</maml:name> <maml:Description> <maml:para>The JavaScript component to include.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The static content for this HTML node. This can be a string or another element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An endpoint that is called to load the content of this element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID for this element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JavaScriptPath</maml:name> <maml:Description> <maml:para>Path to a JavaScript file that contains the JavaScript component to load.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>The name of the JavaScript module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnMount</maml:name> <maml:Description> <maml:para>{{Fill OnMount Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>Properties to pass into the JavaScript component.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>The refresh interval on which to reload the content of this element, in seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>The HTML tag to render.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------------------- Link -----------------------------</maml:title> <dev:code>New-UDElement -Tag "a" -Attributes @{ href = "https://www.google.com" } -Content { "Google" }</dev:code> <dev:remarks> <maml:para>Creates a new anchor tag that links to Google.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDElement.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDEndpoint</command:name> <command:verb>New</command:verb> <command:noun>UDEndpoint</command:noun> <maml:description> <maml:para>Creates a new REST API endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new REST API endpoint. This can be used with Start-UDDashboard nad Start-UDRestApi. All URLs are automatically prefixed with /api.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AcceptFileUpload</maml:name> <maml:Description> <maml:para>Enabled uploading files to this REST API endpoint.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:Description> <maml:para>Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The script block endpoint that is invoked when the URL is called. This script block can provide a param block with arguments that will be passed in from the URL or the body of the request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EvaluateUrlAsRegex</maml:name> <maml:Description> <maml:para>{{Fill EvaluateUrlAsRegex Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of ths endpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:Description> <maml:para>The HTTP method for this endpoint.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GET</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">POST</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PUT</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL for this endpoint. All URLs are automatically prefixed with "/api/". Any portion of the URL that starts with a colon ":", will be treated as a varied and can be accessed in the endpoint script block.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:Description> <maml:para>Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The script block endpoint that is invoked when the URL is called. This script block can provide a param block with arguments that will be passed in from the URL or the body of the request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of ths endpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Schedule</maml:name> <maml:Description> <maml:para>Schedule to run this endpoint on. Use New-UDEndpointSchedule to create a schedule. Pass the endpoint to Start-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EndpointSchedule</command:parameterValue> <dev:type> <maml:name>EndpointSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AcceptFileUpload</maml:name> <maml:Description> <maml:para>Enabled uploading files to this REST API endpoint.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:Description> <maml:para>Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The script block endpoint that is invoked when the URL is called. This script block can provide a param block with arguments that will be passed in from the URL or the body of the request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EvaluateUrlAsRegex</maml:name> <maml:Description> <maml:para>{{Fill EvaluateUrlAsRegex Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of ths endpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:Description> <maml:para>The HTTP method for this endpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Schedule</maml:name> <maml:Description> <maml:para>Schedule to run this endpoint on. Use New-UDEndpointSchedule to create a schedule. Pass the endpoint to Start-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EndpointSchedule</command:parameterValue> <dev:type> <maml:name>EndpointSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL for this endpoint. All URLs are automatically prefixed with "/api/". Any portion of the URL that starts with a colon ":", will be treated as a varied and can be accessed in the endpoint script block.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDEndpoint -Url "user" -Method "GET" -Endpoint { @("Adam", "Sarah", "Bill") | ConvertTo-Json }</dev:code> <dev:remarks> <maml:para>Creates a new REST API endpoint with a URL of "/api/user" that returns Adam, Sarah and Bill as a JSON array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-UDEndpoint -Url "/process/:id" -Method "DELETE" -Endpoint { param($id) Stop-Process -Id $Id }</dev:code> <dev:remarks> <maml:para>Creates a REST API endpoint that stops the process with the ID specified in the URL. You could invoke this endpoint by calling /api/process/1234.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $Endpoint = New-UDEndpoint -Url "/process" -Method "POST" -Endpoint { param($Name) Start-Process -FilePath $Name } PS C:\> Start-UDRestApi -Endpoint $Endpoint PS C:\> Invoke-RestMethod -Uri http://localhost:80/api/process -Body @{Name = "code.exe"} -Method POST</dev:code> <dev:remarks> <maml:para>Creates a REST API endpoint that accepts a HTTP POST with a name parameter in the body. Then it starts the server and invokes the endpoint with Invoke-RestMethod.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDEndpointInitialization</command:name> <command:verb>New</command:verb> <command:noun>UDEndpointInitialization</command:noun> <maml:description> <maml:para>New-UDEndpointInitialization is used to configure the runspaces that Universal Dashboard uses to run Endpoints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New-UDEndpointInitialization is used to configure the runspaces that Universal Dashboard uses to run Endpoints. The cmdlet creates a InitialSessionState object to automatically import variables, functions and modules. You can further customize this object to using the properties and methdos of the InitialSessionState class.</maml:para> <maml:para>For more information, visit: https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.runspaces.initialsessionstate?view=powershellsdk-1.1.0</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDEndpointInitialization</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Function</maml:name> <maml:Description> <maml:para>Functions to import by default into the runspaces used for endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Module</maml:name> <maml:Description> <maml:para>Modules to import by default into the runspaces used for endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variable</maml:name> <maml:Description> <maml:para>Variables to import by default into the runspaces used for endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Function</maml:name> <maml:Description> <maml:para>Functions to import by default into the runspaces used for endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Module</maml:name> <maml:Description> <maml:para>Modules to import by default into the runspaces used for endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variable</maml:name> <maml:Description> <maml:para>Variables to import by default into the runspaces used for endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $MyVariable = "Test" PS C:\> $EI = New-UDEndpointInitialization -Variable "MyVariable" PS C:\> $Dashboard = New-UDDashboard -Title "EI" -Content {} -EndpointInitialization $EI</dev:code> <dev:remarks> <maml:para>Initializes the runspaces with the $MyVariable variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $MyVariable = "Test" PS C:\> $MyOtherVariable = "Test2" PS C:\> $EI = New-UDEndpointInitialization -Variable @("MyVariable", "MyOtherVariable") PS C:\> $Dashboard = New-UDDashboard -Title "EI" -Content {} -EndpointInitialization $EI</dev:code> <dev:remarks> <maml:para>Initializes the runspaces with the $MyVariable and $MyOtherVariable variables.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> function Get-Stuff {} PS C:\> $EI = New-UDEndpointInitialization -Function "Get-Stuff" PS C:\> $Dashboard = New-UDDashboard -Title "EI" -Content {} -EndpointInitialization $EI</dev:code> <dev:remarks> <maml:para>Initializes the runspaces with the Get-Stuff function.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> $EI = New-UDEndpointInitialization -Module "HyperV" PS C:\> $Dashboard = New-UDDashboard -Title "EI" -Content {} -EndpointInitialization $EI</dev:code> <dev:remarks> <maml:para>Initializes the runspaces with the HyperV module.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> $EI = New-UDEndpointInitialization PS C:\> $EI.StartupScripts.Add("C:\test.ps1") PS C:\> $Dashboard = New-UDDashboard -Title "EI" -Content {} -EndpointInitialization $EI</dev:code> <dev:remarks> <maml:para>Initializes the runspaces with a startup script.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDEndpointSchedule</command:name> <command:verb>New</command:verb> <command:noun>UDEndpointSchedule</command:noun> <maml:description> <maml:para>Creates a schedule for an endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a schedule for an endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDEndpointSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Consecutive</maml:name> <maml:Description> <maml:para>Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Cron</maml:name> <maml:Description> <maml:para>A CRON expression to run the schedule under.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDEndpointSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Consecutive</maml:name> <maml:Description> <maml:para>Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Day</maml:name> <maml:Description> <maml:para>Switches the Every value to days.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Every</maml:name> <maml:Description> <maml:para>Number of time units.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Repeat</maml:name> <maml:Description> <maml:para>If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDEndpointSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Consecutive</maml:name> <maml:Description> <maml:para>Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Every</maml:name> <maml:Description> <maml:para>Number of time units.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Repeat</maml:name> <maml:Description> <maml:para>If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Second</maml:name> <maml:Description> <maml:para>Switches the Every value to seconds.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDEndpointSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Consecutive</maml:name> <maml:Description> <maml:para>Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Every</maml:name> <maml:Description> <maml:para>Number of time units.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Minute</maml:name> <maml:Description> <maml:para>Switches the Every value to minutes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Repeat</maml:name> <maml:Description> <maml:para>If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDEndpointSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Consecutive</maml:name> <maml:Description> <maml:para>Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Every</maml:name> <maml:Description> <maml:para>Number of time units.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Hour</maml:name> <maml:Description> <maml:para>Switches the Every value to hours.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Repeat</maml:name> <maml:Description> <maml:para>If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Consecutive</maml:name> <maml:Description> <maml:para>Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Cron</maml:name> <maml:Description> <maml:para>A CRON expression to run the schedule under.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Day</maml:name> <maml:Description> <maml:para>Switches the Every value to days.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Every</maml:name> <maml:Description> <maml:para>Number of time units.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Hour</maml:name> <maml:Description> <maml:para>Switches the Every value to hours.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Minute</maml:name> <maml:Description> <maml:para>Switches the Every value to minutes.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Repeat</maml:name> <maml:Description> <maml:para>If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Second</maml:name> <maml:Description> <maml:para>Switches the Every value to seconds.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $EndpointSchedule = New-UDEndpointSchedule -Every 10 -Second PS C:\> $Endpoint = New-UDEndpoint -Schedule $Schedule -Endpoint { $Cache:Computers = Get-ADComputer }</dev:code> <dev:remarks> <maml:para>Gets a list of computers from Active Directory and stores it in the cache every ten seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $EndpointSchedule = New-UDEndpointSchedule -Every 10 -Second -Consecutive PS C:\> $Endpoint = New-UDEndpoint -Schedule $Schedule -Endpoint { $Cache:Date = Get-Date Start-Sleep -Seconds 21 }</dev:code> <dev:remarks> <maml:para>Gets the current date every 30 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $EndpointSchedule = New-UDEndpointSchedule -Every 10 -Second -Consecutive -Repeat 10 PS C:\> $Endpoint = New-UDEndpoint -Schedule $Schedule -Endpoint { $Cache:Date = Get-Date Start-Sleep -Seconds 21 }</dev:code> <dev:remarks> <maml:para>Gets the current date every 30 seconds 10 times.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDHtml</command:name> <command:verb>New</command:verb> <command:noun>UDHtml</command:noun> <maml:description> <maml:para>Creates a section of HTML.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a section of HTML.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDHtml</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Markup</maml:name> <maml:Description> <maml:para>The HTML markup to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Markup</maml:name> <maml:Description> <maml:para>The HTML markup to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDHtml -Markup "<h3>Hi! I'm HTML</h3>"</dev:code> <dev:remarks> <maml:para>Creates header text in the dashboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDHtml.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDIcon</command:name> <command:verb>New</command:verb> <command:noun>UDIcon</command:noun> <maml:description> <maml:para>Create icon from the FontAwesome pack</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will generate an svg icon from the FontAwesome library, this icons comes from the Solid,Brand and regular packages. The library include 1300+ icons.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDIcon</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>Color</maml:name> <maml:Description> <maml:para>The color of the icon.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ClassName</maml:name> <maml:Description> <maml:para>Add custom css class name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Flip</maml:name> <maml:Description> <maml:para>Flip horizontally, vertically, or both</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">horizontal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">both</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Border</maml:name> <maml:Description> <maml:para>set square border around the icon</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FixedWidth</maml:name> <maml:Description> <maml:para>set the icons to the same fixed width</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Border</maml:name> <maml:Description> <maml:para>set square border around the icon</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ClassName</maml:name> <maml:Description> <maml:para>Add custom css class name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>Color</maml:name> <maml:Description> <maml:para>The color of the icon.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FixedWidth</maml:name> <maml:Description> <maml:para>set the icons to the same fixed width</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Flip</maml:name> <maml:Description> <maml:para>Flip horizontally, vertically, or both</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Icon</maml:name> <maml:Description> <maml:para>{{Fill Icon Description}}</maml:para> <maml:para>```yaml Type: FontAwesomeIcons Parameter Sets: (All) Aliases: Accepted values: None, ad, address_book, address_card, adjust, air_freshener, align_center, align_justify, align_left, align_right, allergies, ambulance, american_sign_language_interpreting, anchor, angle_double_down, angle_double_left, angle_double_right, angle_double_up, angle_down, angle_left, angle_right, angle_up, angry, ankh, apple_alt, archive, archway, arrow_alt_circle_down, arrow_alt_circle_left, arrow_alt_circle_right, arrow_alt_circle_up, arrow_circle_down, arrow_circle_left, arrow_circle_right, arrow_circle_up, arrow_down, arrow_left, arrow_right, arrows_alt, arrows_alt_h, arrows_alt_v, arrow_up, assistive_listening_systems, asterisk, at, atlas, atom, audio_description, award, baby, baby_carriage, backspace, backward, balance_scale, ban, band_aid, barcode, bars, baseball_ball, basketball_ball, bath, battery_empty, battery_full, battery_half, battery_quarter, battery_three_quarters, bed, beer, bell, bell_slash, bezier_curve, bible, bicycle, binoculars, biohazard, birthday_cake, blender, blender_phone, blind, blog, bold, bolt, bomb, bone, bong, book, book_dead, bookmark, book_open, book_reader, bowling_ball, box, boxes, box_open, braille, brain, briefcase, briefcase_medical, broadcast_tower, broom, brush, bug, building, bullhorn, bullseye, burn, bus, bus_alt, business_time, calculator, calendar, calendar_alt, calendar_check, calendar_day, calendar_minus, calendar_plus, calendar_times, calendar_week, camera, camera_retro, campground, candy_cane, cannabis, capsules, car, car_alt, car_battery, car_crash, caret_down, caret_left, caret_right, caret_square_down, caret_square_left, caret_square_right, caret_square_up, caret_up, carrot, car_side, cart_arrow_down, cart_plus, cash_register, cat, certificate, chair, chalkboard, chalkboard_teacher, charging_station, chart_area, chart_bar, chart_line, chart_pie, check, check_circle, check_double, check_square, chess, chess_bishop, chess_board, chess_king, chess_knight, chess_pawn, chess_queen, chess_rook, chevron_circle_down, chevron_circle_left, chevron_circle_right, chevron_circle_up, chevron_down, chevron_left, chevron_right, chevron_up, child, church, circle, circle_notch, city, clipboard, clipboard_check, clipboard_list, clock, clone, closed_captioning, cloud, cloud_download_alt, cloud_meatball, cloud_moon, cloud_moon_rain, cloud_rain, cloud_showers_heavy, cloud_sun, cloud_sun_rain, cloud_upload_alt, cocktail, code, code_branch, coffee, cog, cogs, coins, columns, comment, comment_alt, comment_dollar, comment_dots, comments, comments_dollar, comment_slash, compact_disc, compass, compress, compress_arrows_alt, concierge_bell, cookie, cookie_bite, copy, copyright, couch, credit_card, crop, crop_alt, cross, crosshairs, crow, crown, cube, cubes, cut, database, deaf, democrat, desktop, dharmachakra, diagnoses, dice, dice_d20, dice_d6, dice_five, dice_four, dice_one, dice_six, dice_three, dice_two, digital_tachograph, directions, divide, dizzy, dna, dog, dollar_sign, dolly, dolly_flatbed, donate, door_closed, door_open, dot_circle, dove, download, drafting_compass, dragon, draw_polygon, drum, drum_steelpan, drumstick_bite, dumbbell, dumpster, dumpster_fire, dungeon, edit, eject, ellipsis_h, ellipsis_v, envelope, envelope_open, envelope_open_text, envelope_square, equals, eraser, ethernet, euro_sign, exchange_alt, exclamation, exclamation_circle, exclamation_triangle, expand, expand_arrows_alt, external_link_alt, external_link_square_alt, eye, eye_dropper, eye_slash, fast_backward, fast_forward, fax, feather, feather_alt, female, fighter_jet, file, file_alt, file_archive, file_audio, file_code, file_contract, file_csv, file_download, file_excel, file_export, file_image, file_import, file_invoice, file_invoice_dollar, file_medical, file_medical_alt, file_pdf, file_powerpoint, file_prescription, file_signature, file_upload, file_video, file_word, fill, fill_drip, film, filter, fingerprint, fire, fire_alt, fire_extinguisher, first_aid, fish, fist_raised, flag, flag_checkered, flag_usa, flask, flushed, folder, folder_minus, folder_open, folder_plus, font, font_awesome_logo_full, football_ball, forward, frog, frown, frown_open, funnel_dollar, futbol, gamepad, gas_pump, gavel, gem, genderless, ghost, gift, gifts, glass_cheers, glasses, glass_martini, glass_martini_alt, glass_whiskey, globe, globe_africa, globe_americas, globe_asia, globe_europe, golf_ball, gopuram, graduation_cap, greater_than, greater_than_equal, grimace, grin, grin_alt, grin_beam, grin_beam_sweat, grin_hearts, grin_squint, grin_squint_tears, grin_stars, grin_tears, grin_tongue, grin_tongue_squint, grin_tongue_wink, grin_wink, grip_horizontal, grip_lines, grip_lines_vertical, grip_vertical, guitar, hammer, hamsa, hand_holding, hand_holding_heart, hand_holding_usd, hand_lizard, hand_paper, hand_peace, hand_point_down, hand_pointer, hand_point_left, hand_point_right, hand_point_up, hand_rock, hands, hand_scissors, handshake, hands_helping, hand_spock, hanukiah, hashtag, hat_wizard, haykal, hdd, heading, headphones, headphones_alt, headset, heart, heartbeat, heart_broken, helicopter, highlighter, hiking, hippo, history, hockey_puck, holly_berry, home, horse, horse_head, hospital, hospital_alt, hospital_symbol, hotel, hot_tub, hourglass, hourglass_end, hourglass_half, hourglass_start, house_damage, hryvnia, h_square, icicles, i_cursor, id_badge, id_card, id_card_alt, igloo, image, images, inbox, indent, industry, infinity, info, info_circle, italic, jedi, joint, journal_whills, kaaba, key, keyboard, khanda, kiss, kiss_beam, kiss_wink_heart, kiwi_bird, landmark, language, laptop, laptop_code, laugh, laugh_beam, laugh_squint, laugh_wink, layer_group, leaf, lemon, less_than, less_than_equal, level_down_alt, level_up_alt, life_ring, lightbulb, link, lira_sign, list, list_alt, list_ol, list_ul, location_arrow, _lock, lock_open, long_arrow_alt_down, long_arrow_alt_left, long_arrow_alt_right, long_arrow_alt_up, low_vision, luggage_cart, magic, magnet, mail_bulk, male, map, map_marked, map_marked_alt, map_marker, map_marker_alt, map_pin, map_signs, marker, mars, mars_double, mars_stroke, mars_stroke_h, mars_stroke_v, mask, medal, medkit, meh, meh_blank, meh_rolling_eyes, memory, menorah, mercury, meteor, microchip, microphone, microphone_alt, microphone_alt_slash, microphone_slash, microscope, minus, minus_circle, minus_square, mitten, mobile, mobile_alt, money_bill, money_bill_alt, money_bill_wave, money_bill_wave_alt, money_check, money_check_alt, monument, moon, mortar_pestle, mosque, motorcycle, mountain, mouse_pointer, mug_hot, music, network_wired, neuter, newspaper, not_equal, notes_medical, object_group, object_ungroup, oil_can, om, otter, outdent, paint_brush, paint_roller, palette, pallet, paperclip, paper_plane, parachute_box, paragraph, parking, passport, pastafarianism, paste, pause, pause_circle, paw, peace, pen, pen_alt, pencil_alt, pencil_ruler, pen_fancy, pen_nib, pen_square, people_carry, percent, percentage, person_booth, phone, phone_slash, phone_square, phone_volume, piggy_bank, pills, place_of_worship, plane, plane_arrival, plane_departure, play, play_circle, plug, plus, plus_circle, plus_square, podcast, poll, poll_h, poo, poop, poo_storm, portrait, pound_sign, power_off, pray, praying_hands, prescription, prescription_bottle, prescription_bottle_alt, print, procedures, project_diagram, puzzle_piece, qrcode, question, question_circle, quidditch, quote_left, quote_right, quran, radiation, radiation_alt, rainbow, random, receipt, recycle, redo, redo_alt, registered, reply, reply_all, republican, restroom, retweet, ribbon, ring, road, robot, rocket, route, rss, rss_square, ruble_sign, ruler, ruler_combined, ruler_horizontal, ruler_vertical, running, rupee_sign, sad_cry, sad_tear, satellite, satellite_dish, save, school, screwdriver, scroll, sd_card, search, search_dollar, search_location, search_minus, search_plus, seedling, server, shapes, share, share_alt, share_alt_square, share_square, shekel_sign, shield_alt, ship, shipping_fast, shoe_prints, shopping_bag, shopping_basket, shopping_cart, shower, shuttle_van, sign, signal, signature, sign_in_alt, sign_language, sign_out_alt, sim_card, sitemap, skating, skiing, skiing_nordic, skull, skull_crossbones, slash, sleigh, sliders_h, smile, smile_beam, smile_wink, smog, smoking, smoking_ban, sms, snowboarding, snowflake, snowman, snowplow, socks, solar_panel, sort, sort_alpha_down, sort_alpha_up, sort_amount_down, sort_amount_up, sort_down, sort_numeric_down, sort_numeric_up, sort_up, spa, space_shuttle, spider, spinner, splotch, spray_can, square, square_full, square_root_alt, stamp, star, star_and_crescent, star_half, star_half_alt, star_of_david, star_of_life, step_backward, step_forward, stethoscope, sticky_note, stop, stop_circle, stopwatch, store, store_alt, stream, street_view, strikethrough, stroopwafel, subscript, subway, suitcase, suitcase_rolling, sun, superscript, surprise, swatchbook, swimmer, swimming_pool, synagogue, sync, sync_alt, syringe, table, tablet, tablet_alt, table_tennis, tablets, tachometer_alt, tag, tags, tape, tasks, taxi, teeth, teeth_open, temperature_high, temperature_low, tenge, terminal, text_height, text_width, th, theater_masks, thermometer, thermometer_empty, thermometer_full, thermometer_half, thermometer_quarter, thermometer_three_quarters, th_large, th_list, thumbs_down, thumbs_up, thumbtack, ticket_alt, times, times_circle, tint, tint_slash, tired, toggle_off, toggle_on, toilet, toilet_paper, toolbox, tools, tooth, torah, torii_gate, tractor, trademark, traffic_light, train, tram, transgender, transgender_alt, trash, trash_alt, tree, trophy, truck, truck_loading, truck_monster, truck_moving, truck_pickup, tshirt, tty, tv, umbrella, umbrella_beach, underline, undo, undo_alt, universal_access, university, unlink, unlock, unlock_alt, upload, user, user_alt, user_alt_slash, user_astronaut, user_check, user_circle, user_clock, user_cog, user_edit, user_friends, user_graduate, user_injured, user_lock, user_md, user_minus, user_ninja, user_plus, users, users_cog, user_secret, user_shield, user_slash, user_tag, user_tie, user_times, utensils, utensil_spoon, vector_square, venus, venus_double, venus_mars, vial, vials, video, video_slash, vihara, volleyball_ball, volume_down, volume_mute, volume_off, volume_up, vote_yea, vr_cardboard, walking, wallet, warehouse, water, weight, weight_hanging, wheelchair, wifi, wind, window_close, window_maximize, window_minimize, window_restore, wine_bottle, wine_glass, wine_glass_alt, won_sign, wrench, x_ray, yen_sign, yin_yang, _500px, accessible_icon, accusoft, acquisitions_incorporated, adn, adobe, adversal, affiliatetheme, algolia, alipay, amazon, amazon_pay, amilia, android, angellist, angrycreative, angular, apper, apple, apple_pay, app_store, app_store_ios, artstation, asymmetrik, atlassian, audible, autoprefixer, avianex, aviato, aws, bandcamp, behance, behance_square, bimobject, bitbucket, bitcoin, bity, blackberry, black_tie, blogger, blogger_b, bluetooth, bluetooth_b, btc, buromobelexperte, buysellads, canadian_maple_leaf, cc_amazon_pay, cc_amex, cc_apple_pay, cc_diners_club, cc_discover, cc_jcb, cc_mastercard, cc_paypal, cc_stripe, cc_visa, centercode, centos, chrome, cloudscale, cloudsmith, cloudversify, codepen, codiepie, confluence, connectdevelop, contao, cpanel, creative_commons, creative_commons_by, creative_commons_nc, creative_commons_nc_eu, creative_commons_nc_jp, creative_commons_nd, creative_commons_pd, creative_commons_pd_alt, creative_commons_remix, creative_commons_sa, creative_commons_sampling, creative_commons_sampling_plus, creative_commons_share, creative_commons_zero, critical_role, css3, css3_alt, cuttlefish, d_and_d, d_and_d_beyond, dashcube, delicious, deploydog, deskpro, dev, deviantart, dhl, diaspora, digg, digital_ocean, discord, discourse, dochub, docker, draft2digital, dribbble, dribbble_square, dropbox, drupal, dyalog, earlybirds, ebay, edge, elementor, ello, ember, empire, envira, erlang, ethereum, etsy, expeditedssl, facebook, facebook_f, facebook_messenger, facebook_square, fantasy_flight_games, fedex, fedora, figma, firefox, firstdraft, first_order, first_order_alt, flickr, flipboard, fly, font_awesome, font_awesome_alt, font_awesome_flag, fonticons, fonticons_fi, fort_awesome, fort_awesome_alt, forumbee, foursquare, freebsd, free_code_camp, fulcrum, galactic_republic, galactic_senate, get_pocket, gg, gg_circle, git, github, github_alt, github_square, gitkraken, gitlab, git_square, gitter, glide, glide_g, gofore, goodreads, goodreads_g, google, google_drive, google_play, google_plus, google_plus_g, google_plus_square, google_wallet, gratipay, grav, gripfire, grunt, gulp, hacker_news, hacker_news_square, hackerrank, hips, hire_a_helper, hooli, hornbill, hotjar, houzz, html5, hubspot, imdb, instagram, intercom, internet_explorer, invision, ioxhost, itunes, itunes_note, java, jedi_order, jenkins, jira, joget, joomla, js, jsfiddle, js_square, kaggle, keybase, keycdn, kickstarter, kickstarter_k, korvue, laravel, lastfm, lastfm_square, leanpub, less, line, linkedin, linkedin_in, linode, linux, lyft, magento, mailchimp, mandalorian, markdown, mastodon, maxcdn, medapps, medium, medium_m, medrt, meetup, megaport, mendeley, microsoft, mix, mixcloud, mizuni, modx, monero, napster, neos, nimblr, nintendo_switch, node, node_js, npm, ns8, nutritionix, odnoklassniki, odnoklassniki_square, old_republic, opencart, openid, opera, optin_monster, osi, page4, pagelines, palfed, patreon, paypal, penny_arcade, periscope, phabricator, phoenix_framework, phoenix_squadron, php, pied_piper, pied_piper_alt, pied_piper_hat, pied_piper_pp, pinterest, pinterest_p, pinterest_square, playstation, product_hunt, pushed, python, qq, quinscape, quora, raspberry_pi, ravelry, react, reacteurope, readme, rebel, reddit, reddit_alien, reddit_square, redhat, red_river, renren, replyd, researchgate, resolving, rev, rocketchat, rockrms, r_project, safari, sass, schlix, scribd, searchengin, sellcast, sellsy, servicestack, shirtsinbulk, shopware, simplybuilt, sistrix, sith, sketch, skyatlas, skype, slack, slack_hash, slideshare, snapchat, snapchat_ghost, snapchat_square, soundcloud, sourcetree, speakap, spotify, squarespace, stack_exchange, stack_overflow, staylinked, steam, steam_square, steam_symbol, sticker_mule, strava, stripe, stripe_s, studiovinari, stumbleupon, stumbleupon_circle, superpowers, supple, suse, teamspeak, telegram, telegram_plane, tencent_weibo, themeco, themeisle, the_red_yeti, think_peaks, trade_federation, trello, tripadvisor, tumblr, tumblr_square, twitch, twitter, twitter_square, typo3, uber, ubuntu, uikit, uniregistry, untappd, ups, usb, usps, ussunnah, vaadin, viacoin, viadeo, viadeo_square, viber, vimeo, vimeo_square, vimeo_v, vine, vk, vnv, vuejs, weebly, weibo, weixin, whatsapp, whatsapp_square, whmcs, wikipedia_w, windows, wix, wizards_of_the_coast, wolf_pack_battalion, wordpress, wordpress_simple, wpbeginner, wpexplorer, wpforms, wpressr, xbox, xing, xing_square, yahoo, yandex, yandex_international, yarn, y_combinator, yelp, yoast, youtube, youtube_square, zhihu, address_book_o, address_card_o, vcard_o, vcard, signing, asl_interpreting, arrow_circle_o_down, arrow_circle_o_left, arrow_circle_o_right, arrow_circle_o_up, arrows, arrows_h, arrows_v, reorder, navicon, bathtub, s15, battery_0, battery, battery_4, battery_2, battery_1, battery_3, bell_o, bell_slash_o, flash, bookmark_o, building_o, calendar_o, calendar_check_o, calendar_minus_o, calendar_plus_o, calendar_times_o, automobile, caret_square_o_down, caret_square_o_left, caret_square_o_right, toggle_down, toggle_left, toggle_right, caret_square_o_up, toggle_up, area_chart, bar_chart_o, bar_chart, line_chart, pie_chart, check_circle_o, check_square_o, circle_o, circle_thin, circle_o_notch, clock_o, cloud_download, cloud_upload, code_fork, gear, gears, comment_o, commenting, commenting_o, comments_o, files_o, credit_card_alt, cc, scissors, deafness, hard_of_hearing, usd, dollar, dot_circle_o, envelope_o, envelope_open_o, euro, eur, exchange, warning, external_link_square, external_link, eyedropper, file_o, file_text_o, file_text, file_zip_o, file_archive_o, file_audio_o, file_sound_o, file_code_o, file_excel_o, file_photo_o, file_picture_o, file_image_o, file_pdf_o, file_powerpoint_o, file_movie_o, file_video_o, file_word_o, flag_o, folder_o, folder_open_o, frown_o, futbol_o, soccer_ball_o, legal, diamond, mortar_board, hand_lizard_o, hand_paper_o, hand_stop_o, hand_peace_o, hand_o_down, hand_pointer_o, hand_o_left, hand_o_right, hand_o_up, hand_rock_o, hand_grab_o, hand_scissors_o, handshake_o, hand_spock_o, hdd_o, header, heart_o, hospital_o, hourglass_o, hourglass_1, hourglass_2, hourglass_3, drivers_license_o, drivers_license, id_card_o, photo, picture_o, keyboard_o, lemon_o, level_down, level_up, life_bouy, life_buoy, support, life_saver, lightbulb_o, chain, turkish_lira, _try, long_arrow_down, long_arrow_left, long_arrow_right, long_arrow_up, map_o, meh_o, minus_square_o, money, moon_o, newspaper_o, dedent, send, paper_plane_o, send_o, pause_circle_o, pencil_square, pencil_square_o, pencil, mobile_phone, volume_control_phone, bank, plus_square_o, play_circle_o, gbp, question_circle_o, rotate_right, repeat, mail_reply, mail_reply_all, feed, rouble, ruble, rub, inr, rupee, floppy_o, mail_forward, share_square_o, ils, shekel, sheqel, shield, sign_in, sign_out, sliders, smile_o, snowflake_o, unsorted, sort_alpha_asc, sort_alpha_desc, sort_amount_asc, sort_amount_desc, sort_asc, sort_numeric_asc, sort_numeric_desc, sort_desc, square_o, star_o, star_half_empty, star_half_o, star_half_full, sticky_note_o, stop_circle_o, sun_o, refresh, tachometer, dashboard, cab, thermometer_0, thermometer_4, thermometer_2, thermometer_1, thermometer_3, thumb_tack, thumbs_o_down, thumbs_o_up, ticket, times_rectangle, remove, times_rectangle_o, times_circle_o, intersex, trash_o, television, rotate_left, institution, chain_broken, user_o, user_circle_o, group, cutlery, spoon, wheelchair_alt, window_close_o, close, glass, won, krw, cny, jpy, yen, rmb, bitbucket_square, ge, facebook_official, fa, google_plus_official, google_plus_circle, gittip, linkedin_square, ra, resistance, eercast, yc, y_combinator_square, yc_square, youtube_play</maml:para> <maml:para>Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Id Set css id property</maml:para> <maml:para>```yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Inverse {{Fill Inverse Description}}</maml:para> <maml:para>```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -ListItem {{Fill ListItem Description}}</maml:para> <maml:para>```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Pull {{Fill Pull Description}}</maml:para> <maml:para>```yaml Type: String Parameter Sets: (All) Aliases: Accepted values: right, left</maml:para> <maml:para>Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Pulse Use this to have the icon to rotate with 8 steps</maml:para> <maml:para>```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Regular This switch if define will search the icon in the FontAwesome regular pack, if the icon is not in the regular pack the command will used the fallback icon in the solid pack.</maml:para> <maml:para>```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Rotation Wil rotate the icon by 90 degress </maml:para> <maml:para>```yaml Type: Int32 Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Size Set the size of the icon</maml:para> <maml:para>```yaml Type: String Parameter Sets: (All) Aliases: Accepted values: xs, sm, lg, 2x, 3x, 4x, 5x, 6x, 7x, 8x, 9x, 10x</maml:para> <maml:para>Required: False Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Spin Will spin the icon like loading animation</maml:para> <maml:para>```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Style Set css attributes on the icon like color etc...</maml:para> <maml:para>```yaml Type: Hashtable Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Title {{Fill Title Description}}</maml:para> <maml:para>```yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### -Transform Thanks to the power of SVG in Font Awesome 5, you can scale, position, flip, & rotate icons arbitrarily using the data-fa-transform element attribute. You can even combine them for some super-useful effects.</maml:para> <maml:para>```yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> <maml:para>### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).</maml:para> <maml:para>## INPUTS</maml:para> <maml:para>### None</maml:para> <maml:para>## OUTPUTS</maml:para> <maml:para>### System.Object</maml:para> <maml:para>## NOTES</maml:para> <maml:para>## RELATED LINKS</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDIcon -Icon box -Style @{color = '#000'} -Id 'test-icon-button'</dev:code> <dev:remarks> <maml:para>Create icon with the default size sm and it has black color.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-UDIcon -Icon spinner -Size 3x -Style @{color = '#000'} -Id 'test-icon-button' -Spin</dev:code> <dev:remarks> <maml:para>Create icon that has spin animation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>New-UDIcon -Icon angry -Size 3x -Style @{color = '#000'} -Id 'test-icon-button' -Regular</dev:code> <dev:remarks> <maml:para>Create angry icon that have a size of 3 and black color, and also this icon is from the FontAwesome regular pack ( semi light ) style.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDIcon.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDIFrame</command:name> <command:verb>New</command:verb> <command:noun>UDIFrame</command:noun> <maml:description> <maml:para>Creates a new iframe.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new iframe.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDIFrame</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the iframe.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>The URI of the embedded website.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the iframe.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>The URI of the embedded website.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDIFrame -Uri https://www.ironmansoftware.com</dev:code> <dev:remarks> <maml:para>Creates an iframe that embeds Google.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDIframe.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDImage</command:name> <command:verb>New</command:verb> <command:noun>UDImage</command:noun> <maml:description> <maml:para>Renders an image in the dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Renders an image in the dashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDImage</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>{{Fill Attributes Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>The height in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the image.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The Path of the icon on the local file system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>The width in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDImage</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>{{Fill Attributes Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>The height in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the image.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the image. This can be a base64 encoded data string.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>The width in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>{{Fill Attributes Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>The height in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the image.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The Path of the icon on the local file system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the image. This can be a base64 encoded data string.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>The width in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDImage -Url "https://i1.wp.com/ironmansoftware.com/wp-content/uploads/2019/01/dsl.png" -Height 50 -Width 50</dev:code> <dev:remarks> <maml:para>Inserts the Google logo and sizes it to 50px by 50px.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-UDImage -Height 125 -Width 125 -Url "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYwIiBoZWlnaHQ9IjE2MCIgdmlld0JveD0iMCAwIDE2MCAxNjAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHRpdGxlPkFydGJvYXJkIDY8L3RpdGxlPjxnIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCI+PHBhdGggZD0iTTE0NC4wODYgODAuNTY4Yy0yMS45NzguNDMtMTcuNDAyIDE0LjM0Ni0zMi44OSAxNy44NjZDOTUuNDYgMTAyLjAxIDkyLjk3NSA2MCA3Ny4yNDMgNjBjLTE1LjczMyAwLTE5LjIxNiA0MC44MDYtMzguOTE4IDY4LjgyM2wtLjU2Ljc5NEw4MCAxNTRsNjQuMDg2LTM3VjgwLjU2OHoiIGZpbGw9IiMzNkEyRUIiLz48cGF0aCBkPSJNMTQ0LjA4NiA3OS4zQzEzNi43MjYgNjkuODU2IDEzMS43MzYgNTkgMTIxIDU5Yy0xOSAwLTE0IDMxLTM1IDMxcy0yMy4yMDctMzMuMzQ2LTQ3LTJjLTcuNTggOS45ODgtMTMuNjgyIDIxLjEyNC0xOC40NzUgMzEuNjYyTDgwIDE1NGw2NC4wODYtMzdWNzkuM3oiIGZpbGw9IiNGRkNFNTYiLz48cGF0aCBkPSJNMTUuOTE0IDkyLjE0M0MyMy4xMjQgNzIuMTczIDI2LjIzNyA1NiA0MCA1NmMyMSAwIDI2IDU5IDQ0IDUzczE2LTM4IDQ0LTM4YzUuMzMgMCAxMC43NzIgMy4yNjMgMTYuMDg2IDguNTQ2VjExN0w4MCAxNTRsLTY0LjA4Ni0zN1Y5Mi4xNDN6IiBmaWxsLW9wYWNpdHk9Ii44IiBmaWxsPSIjRkU2MTg0Ii8+PHBhdGggc3Ryb2tlPSIjRTdFOUVEIiBzdHJva2Utd2lkdGg9IjgiIGQ9Ik04MCA2bDY0LjA4NiAzN3Y3NEw4MCAxNTRsLTY0LjA4Ni0zN1Y0M3oiLz48L2c+PC9zdmc+"</dev:code> <dev:remarks> <maml:para>Inserts an SVG, base64 logo and sizes it to 50px by 50px.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDImage.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDLink</command:name> <command:verb>New</command:verb> <command:noun>UDLink</command:noun> <maml:description> <maml:para>Creates an HTML link.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates an HTML link.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDLink</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of this link element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Text</maml:name> <maml:Description> <maml:para>Text for the link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>Url for the link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Icon</maml:name> <maml:Description> <maml:para>A FontAwesome icon to display before the link text.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>The font color for this link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>OnClick</maml:name> <maml:Description> <maml:para>The click handler for when this link is clicked.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OpenInNewWindow</maml:name> <maml:Description> <maml:para>Opens the link in a new window.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>The font color for this link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Icon</maml:name> <maml:Description> <maml:para>A FontAwesome icon to display before the link text.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of this link element.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>OnClick</maml:name> <maml:Description> <maml:para>The click handler for when this link is clicked.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OpenInNewWindow</maml:name> <maml:Description> <maml:para>Opens the link in a new window.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Text</maml:name> <maml:Description> <maml:para>Text for the link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>Url for the link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDLink -Text "PowerShell Pro Tools" -Url "https://www.poshtools.com"</dev:code> <dev:remarks> <maml:para>Creates an HTML link to PoshTools.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDLink.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDLoadingScreen</command:name> <command:verb>New</command:verb> <command:noun>UDLoadingScreen</command:noun> <maml:description> <maml:para>Customizations for the loading screen.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Customizations for the loading screen.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDLoadingScreen</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color of loading screen.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HideSplash</maml:name> <maml:Description> <maml:para>Hides the splash screen completely.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:Description> <maml:para>Text to show on the loading screen.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TextColor</maml:name> <maml:Description> <maml:para>Text color of loading screen.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color of loading screen.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HideSplash</maml:name> <maml:Description> <maml:para>Hides the splash screen completely.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:Description> <maml:para>Text to show on the loading screen.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TextColor</maml:name> <maml:Description> <maml:para>Text color of loading screen.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDLoadingScreen -BackgroundColor Blue -TextColor White</dev:code> <dev:remarks> <maml:para>Updates the loading screen to have a blue background color and a white text color.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDRow</command:name> <command:verb>New</command:verb> <command:noun>UDRow</command:noun> <maml:description> <maml:para>Creates a new row on the dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new row on the dashboard. Columns are defined with New-UDColumn.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDRow</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether this row should autorefresh.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The endpoint to call when generating the content for this row.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the row. This is the HTML markup ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>The number of seconds between refreshes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-UDRow</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Columns</maml:name> <maml:Description> <maml:para>The columns to define for the row. These columns should be defined using New-UDColumn.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the row. This is the HTML markup ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoRefresh</maml:name> <maml:Description> <maml:para>Whether this row should autorefresh.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Columns</maml:name> <maml:Description> <maml:para>The columns to define for the row. These columns should be defined using New-UDColumn.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>The endpoint to call when generating the content for this row.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the row. This is the HTML markup ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RefreshInterval</maml:name> <maml:Description> <maml:para>The number of seconds between refreshes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDRow { New-UDColumn -Size 6 { New-UDCard -Content {} -BackgroundColor black } New-UDColumn -Size 6 { New-UDCard -Content {} -BackgroundColor black } }</dev:code> <dev:remarks> <maml:para>Defines a row with two columns are equal size.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-UDRow { New-UDColumn -Size 6 { New-UDRow { New-UDColumn -Size 6 { New-UDCard -Content {} -BackgroundColor black } New-UDColumn -Size 6 { New-UDCard -Content {} -BackgroundColor black } } } New-UDColumn -Size 6 { New-UDCard -Content {} -BackgroundColor black } }</dev:code> <dev:remarks> <maml:para>Defines a row with two columns are equal size. Inside the first column is another row with two columns.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/ironmansoftware/universal-dashboard/blob/master/src/UniversalDashboard/Help/New-UDRow.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDSpan</command:name> <command:verb>New</command:verb> <command:noun>UDSpan</command:noun> <maml:description> <maml:para>Creates a span of content.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a span of content.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDSpan</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID for this span.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>Content for this span.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>Content for this span.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID for this span.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDSpan -Content { New-UDHeading -Text "Header" }</dev:code> <dev:remarks> <maml:para>Creates a header within a span.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDSplitPane</command:name> <command:verb>New</command:verb> <command:noun>UDSplitPane</command:noun> <maml:description> <maml:para>Creates a split pane between two controls that you can adjust the size of.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a split pane between two controls that you can adjust the size of.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDSplitPane</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the split pane.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The controls to create the split pane for. This is should contain exactly two controls.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Direction</maml:name> <maml:Description> <maml:para>Whether you want a split panel that is vertical or horizontal</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">horizontal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>MinimumSize</maml:name> <maml:Description> <maml:para>Minimum size in pixels of the panes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>DefaultSize</maml:name> <maml:Description> <maml:para>The default size in pixels of the top or left component.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The controls to create the split pane for. This is should contain exactly two controls.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>DefaultSize</maml:name> <maml:Description> <maml:para>The default size in pixels of the top or left component.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Direction</maml:name> <maml:Description> <maml:para>Whether you want a split panel that is vertical or horizontal</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the split pane.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>MinimumSize</maml:name> <maml:Description> <maml:para>Minimum size in pixels of the panes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------------ Vertical Pane ------------------------</maml:title> <dev:code>New-UDSplitPane -Content { New-UDCard -Title 'Side 1' -Content {} New-UDCard -Title 'Side 2' -Content {} }</dev:code> <dev:remarks> <maml:para>Creates a vertical split pane.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------------- Horizontal Pane -----------------------</maml:title> <dev:code>New-UDSplitPane -Content { New-UDCard -Title 'Side 1' -Content {} New-UDCard -Title 'Side 2' -Content {} } -Direction horizontal</dev:code> <dev:remarks> <maml:para>Creates a horizontal split pane.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDTheme</command:name> <command:verb>New</command:verb> <command:noun>UDTheme</command:noun> <maml:description> <maml:para>Creates a new theme for a dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new theme for a dashboard. Themes can be based on another parent theme.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDTheme</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of this theme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Definition</maml:name> <maml:Description> <maml:para>The definition for the dashboard theme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Parent</maml:name> <maml:Description> <maml:para>The name of the parent theme. Use Get-UDTheme to get a list of available parent themes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Definition</maml:name> <maml:Description> <maml:para>The definition for the dashboard theme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of this theme.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Parent</maml:name> <maml:Description> <maml:para>The name of the parent theme. Use Get-UDTheme to get a list of available parent themes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDTheme -Name "Blue" -Definition @{ UDDashboard = @{ BackgroundColor = "blue" } }</dev:code> <dev:remarks> <maml:para>Creates a theme where the background color of the dashboard is blue.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-UDTheme -Name "AzureEx" -Parent Azure -Definition @{ UDDashboard = @{ BackgroundColor = "blue" } }</dev:code> <dev:remarks> <maml:para>Creates a theme where the background color of the dashboard is blue and the rest of the dashboard colors are based on the Azure parent dashboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDTooltip</command:name> <command:verb>New</command:verb> <command:noun>UDTooltip</command:noun> <maml:description> <maml:para>Creates a tooltip around a control.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a tooltip around a control.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDTooltip</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the tooltip</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Place</maml:name> <maml:Description> <maml:para>Where to place the tooltip.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">top</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">bottom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">left</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">right</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The style of the tooltype</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">dark</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">info</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">light</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Effect</maml:name> <maml:Description> <maml:para>Float or solid effect</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">float</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">solid</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>TooltipContent</maml:name> <maml:Description> <maml:para>The content within the tooltip</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content that is hovered that will display the tooltip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content that is hovered that will display the tooltip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Effect</maml:name> <maml:Description> <maml:para>Float or solid effect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the tooltip</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Place</maml:name> <maml:Description> <maml:para>Where to place the tooltip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>TooltipContent</maml:name> <maml:Description> <maml:para>The content within the tooltip</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The style of the tooltype</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------------- A basic tool tip -----------------------</maml:title> <dev:code>New-UDTooltip -TooltipContent { "Hello, there!" } -Content { New-UDIcon -Icon 'user' }</dev:code> <dev:remarks> <maml:para>Creates a basic tool tip</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDChartData</command:name> <command:verb>Out</command:verb> <command:noun>UDChartData</command:noun> <maml:description> <maml:para>Outputs data in a format that the ChartJS control understands.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data in a format that the ChartJS control understands.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDChartData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>Data to display in the chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DataProperty</maml:name> <maml:Description> <maml:para>The property to select as the y-axis of the data set. This should be used in conjunction with LabelProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>LabelProperty</maml:name> <maml:Description> <maml:para>The property to select as the dataset label (x-axis). This should be used in conjunction with DataProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DatasetLabel</maml:name> <maml:Description> <maml:para>The label for a dataset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Dataset</maml:name> <maml:Description> <maml:para>A collection of hashtables created by New-UDChartDataset. This allows for multiple datasets to be represented on a single chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>BorderColor</maml:name> <maml:Description> <maml:para>Border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>HoverBackgroundColor</maml:name> <maml:Description> <maml:para>Hover background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>HoverBorderColor</maml:name> <maml:Description> <maml:para>Hover border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>BorderColor</maml:name> <maml:Description> <maml:para>Border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>Data to display in the chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DataProperty</maml:name> <maml:Description> <maml:para>The property to select as the y-axis of the data set. This should be used in conjunction with LabelProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Dataset</maml:name> <maml:Description> <maml:para>A collection of hashtables created by New-UDChartDataset. This allows for multiple datasets to be represented on a single chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DatasetLabel</maml:name> <maml:Description> <maml:para>The label for a dataset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>HoverBackgroundColor</maml:name> <maml:Description> <maml:para>Hover background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>HoverBorderColor</maml:name> <maml:Description> <maml:para>Hover border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>LabelProperty</maml:name> <maml:Description> <maml:para>The property to select as the dataset label (x-axis). This should be used in conjunction with DataProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDChart -Type Line -Title "CPU" -Endpoint { Get-Process -Name chrome | Out-UDChartData -LabelProperty "Id" -DataProperty "CPU" }</dev:code> <dev:remarks> <maml:para>Outputs data from Get-Process and selects the Id as the label (x-axis) and the CPU as the data (y-axis).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-UDChart -Type Bar -Title "Memory" -Endpoint { Get-Process -Name chrome | Out-UDChartData -LabelProperty "Id" -Dataset @( New-UDChartDataset -DataProperty "WorkingSet" -Label "Working Set" -BackgroundColor "rgb(63,123,3)" New-UDChartDataset -DataProperty "PeakWorkingSet" -Label "Peak Working Set" -BackgroundColor "rgb(134,342,122)" New-UDChartDataset -DataProperty "VirtualMemorySize" -Label "Virtual Memory Size" -BackgroundColor "rgb(234,33,43)" ) }</dev:code> <dev:remarks> <maml:para>Outputs data from Get-Process and selects WorkingSet, PeakWorkingSet and VritualMemorySize as data sets from the output.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDMonitorData</command:name> <command:verb>Out</command:verb> <command:noun>UDMonitorData</command:noun> <maml:description> <maml:para>Outputs data for the New-UDMonitor components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data for the New-UDMonitor components. The data value should be a single data point.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDMonitorData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>A single data point on the running monitor.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>A single data point on the running monitor.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDMonitor -Type Line -Title "Available Memory" -RefreshInterval 1 -DataPointHistory 100 -Endpoint { Get-Counter '\Memory\Available MBytes' | Select-Object -ExpandProperty CounterSamples | Select -ExpandProperty CookedValue | Out-UDMonitorData }</dev:code> <dev:remarks> <maml:para>Outputs the available memory on the current machine.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-UDFolder</command:name> <command:verb>Publish</command:verb> <command:noun>UDFolder</command:noun> <maml:description> <maml:para>Publishes a folder that will be available to download assets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publishes a folder that will be available to download assets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-UDFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Local path for the folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RequestPath</maml:name> <maml:Description> <maml:para>The request path for the folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Local path for the folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RequestPath</maml:name> <maml:Description> <maml:para>The request path for the folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Publish-UDFolder</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDTableData</command:name> <command:verb>Out</command:verb> <command:noun>UDTableData</command:noun> <maml:description> <maml:para>Outputs data as a table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data as a table.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDTableData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The data to show in the table.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>The properties, or columns, to display in the table. Should match the -Header parameter of New-UDTable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DateTimeFormat</maml:name> <maml:Description> <maml:para></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The data to show in the table.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DateTimeFormat</maml:name> <maml:Description> <maml:para></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>The properties, or columns, to display in the table. Should match the -Header parameter of New-UDTable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDTable -Title "Process Ids" -Header @("Name", "Process Id") -Endpoint { Get-Process -Name Chrome | Out-UDTableData -Property @("name", "id") }</dev:code> <dev:remarks> <maml:para>Outputs data from Get-Process as a table. Selects the Name and ID property from each item.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-UDElement</command:name> <command:verb>Remove</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Removes an element from the website.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an element from the website. If broadcast is specified, all connected users will get the element removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-UDElement -Id "chatroom"</dev:code> <dev:remarks> <maml:para>Removes the chatroom element from the connected clients website.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-UDElement</command:name> <command:verb>Select</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Selects an element.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Selects an element, and optionally scrolls to it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-UDElement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>The ID of the element to select.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScrollToElemenet</maml:name> <maml:Description> <maml:para></maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTop</maml:name> <maml:Description> <maml:para></maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>The ID of the element to select.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScrollToElemenet</maml:name> <maml:Description> <maml:para></maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTop</maml:name> <maml:Description> <maml:para></maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Select-UDElement -Id 'textbox' -ScrollToElement</dev:code> <dev:remarks> <maml:para>Selects the text box with the ID 'textbox' and scrolls to the position on page.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Select-UDElement -ToTop</dev:code> <dev:remarks> <maml:para>Scrolls the page to the top.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-UDToast</command:name> <command:verb>Send</command:verb> <command:noun>UDToast</command:noun> <maml:description> <maml:para>Sends a toast message from an endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a toast message from an endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-UDToast</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>A message to show to the user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>The number of milliseconds to show the toast.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>The number of milliseconds to show the toast.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>A message to show to the user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDButton -Text "Click me" -OnClick { Send-UDToast -Message 'Ouch!" }</dev:code> <dev:remarks> <maml:para>Sends a toast to the user when the button is clicked.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDClipboard</command:name> <command:verb>Set</command:verb> <command:noun>UDClipboard</command:noun> <maml:description> <maml:para>Sets the contents of the clipboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the contents of the clipboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDClipboard</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The text to set into the clipboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>toastOnError</maml:name> <maml:Description> <maml:para>Creates a toast when it fails to set the clipboard text.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>toastOnSuccess</maml:name> <maml:Description> <maml:para>Creates a toast when it succeeds to set the clipboard text.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The text to set into the clipboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>toastOnError</maml:name> <maml:Description> <maml:para>Creates a toast when it fails to set the clipboard text.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>toastOnSuccess</maml:name> <maml:Description> <maml:para>Creates a toast when it succeeds to set the clipboard text.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-UDHeading -Size 5 -Text 'You just copy me!!' New-UDButton -Floating -Icon clipboard -OnClick { Set-UDClipboard -Data 'You just copy me!!' }</dev:code> <dev:remarks> <maml:para>Sets 'You just copy me!!' into the clipboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-UDTextbox -Label "Textbox" -Placeholder "Enter your name" -Id 'textToCopy' New-UDButton -Icon clipboard -OnClick { $Element = Get-UDElement -Id 'textToCopy' $text = $Element.Attributes.value Set-UDClipboard -Data $text }</dev:code> <dev:remarks> <maml:para>Sets text box value into the clipboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>New-UDTextbox -Label "Textbox" -Placeholder "Enter your name" -Id 'textToCopySuccess' New-UDButton -Icon clipboard -OnClick { $Element = Get-UDElement -Id 'textToCopySuccess' $text = $Element.Attributes.value Set-UDClipboard -Data $text -toastOnSuccess }</dev:code> <dev:remarks> <maml:para>Sets text box value into the clipboard and show toast message on success.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>New-UDTextbox -Label "Textbox" -Placeholder "Enter your name" -Id 'textToCopyFail' New-UDButton -Icon clipboard -OnClick { $Element = Get-UDElement -Id 'textToCopyFailed' $text = $Element.Attributes.value Set-UDClipboard -Data $text -toastOnError }</dev:code> <dev:remarks> <maml:para>Sets text box value into the clipboard and show toast message on failed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>New-UDButton -Text "Show Modal" -OnClick { Show-UDModal -Header { New-UDHeading -Size 4 -Text "This is the text to copy" } -Content { 'This is the text to copy' New-UDButton -Floating -Icon clipboard -OnClick { Set-UDClipboard -Data 'This is the text to copy' } } }</dev:code> <dev:remarks> <maml:para>Shows a modal with button that set text in the clipboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDContentType</command:name> <command:verb>Set</command:verb> <command:noun>UDContentType</command:noun> <maml:description> <maml:para>Sets the content-type HTTP header for a HTTP response.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the content-type HTTP header for a HTTP response. This should be in control's Endpoint script blocks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDContentType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ContentType</maml:name> <maml:Description> <maml:para>The content type to set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ContentType</maml:name> <maml:Description> <maml:para>The content type to set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UDContentType -ContentType "application/xml"</dev:code> <dev:remarks> <maml:para>Sets the content type to XML if an endpoint wanted to return XML.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDCookie</command:name> <command:verb>Set</command:verb> <command:noun>UDCookie</command:noun> <maml:description> <maml:para>Sets a response cookie in the UD response.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets a response cookie in the UD response.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDCookie</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The value of the cookie</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CookieOptions</maml:name> <maml:Description> <maml:para>Additional cookie options to set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Microsoft.AspNetCore.Http.CookieOptions</command:parameterValue> <dev:type> <maml:name>Microsoft.AspNetCore.Http.CookieOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The value of the cookie</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CookieOptions</maml:name> <maml:Description> <maml:para>Additional cookie options to set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Microsoft.AspNetCore.Http.CookieOptions</command:parameterValue> <dev:type> <maml:name>Microsoft.AspNetCore.Http.CookieOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UDCookie -Name 'MyCookie' -Value 'CookieValue'</dev:code> <dev:remarks> <maml:para>Sets a response cookie.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDElement</command:name> <command:verb>Set</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Sets the state of an element.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the state of an element. If broadcast is specified, all connected users will get the element removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>The attributes to set. The attriubte hashtable is currently not merged so all attributes sent previously will be overridden.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the element to update. Existing content will be replace with the content specified here.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>The attributes to set. The attriubte hashtable is currently not merged so all attributes sent previously will be overridden.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Add the element to all connected clients. If you don't specify this Switch, the element will only be added to whoever is interacting with the website.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the element to update. Existing content will be replace with the content specified here.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the element to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UDElement -Id "message" -Attributes @{ type = "text" value = '' placeholder = "Type a chat message" }</dev:code> <dev:remarks> <maml:para>Sets the "message" element to new attributes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDLicense</command:name> <command:verb>Set</command:verb> <command:noun>UDLicense</command:noun> <maml:description> <maml:para>Installs a PowerShell Pro Tools license</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Installs a PowerShell Pro Tools license</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDLicense</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>License</maml:name> <maml:Description> <maml:para>The contents of a license.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>License</maml:name> <maml:Description> <maml:para>The contents of a license.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UDLicense -License "<License>sdfadfasdf</License>"</dev:code> <dev:remarks> <maml:para>Installs a PowerShell Pro Tools license</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-UDModal</command:name> <command:verb>Show</command:verb> <command:noun>UDModal</command:noun> <maml:description> <maml:para>Shows a modal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Shows a modal. This can be called from any endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-UDModal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>The background color of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BottomSheet</maml:name> <maml:Description> <maml:para>Whether this is a bottom sheet modal.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FixedFooter</maml:name> <maml:Description> <maml:para>Whether this modal has a fixed footer.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>The font color for items in the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>The footer for the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>The header of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>The height of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Persistent</maml:name> <maml:Description> <maml:para>Creates a modal that cannot click away from.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>The width of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>The background color of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BottomSheet</maml:name> <maml:Description> <maml:para>Whether this is a bottom sheet modal.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FixedFooter</maml:name> <maml:Description> <maml:para>Whether this modal has a fixed footer.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FontColor</maml:name> <maml:Description> <maml:para>The font color for items in the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>The footer for the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>The header of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>The height of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Persistent</maml:name> <maml:Description> <maml:para>Creates a modal that cannot click away from.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>The width of the modal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------------- Basic Modal -------------------------</maml:title> <dev:code>New-UDButton -Text "Show Modal" -OnClick { Show-UDModal -Header { New-UDHeading -Size 4 -Text "Modal" } -Content { "This is a modal" } }</dev:code> <dev:remarks> <maml:para>Shows a modal when the button is clicked.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------------- Bottom Sheet -------------------------</maml:title> <dev:code>New-UDButton -Text "Show Modal" -OnClick { Show-UDModal -Header { New-UDHeading -Size 4 -Text "Modal" } -Content { "This is a modal" } -BottomSheet }</dev:code> <dev:remarks> <maml:para>Shows a bottom sheet modal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Persistent --------------------------</maml:title> <dev:code>New-UDButton -Text "Show Modal" -OnClick { Show-UDModal -Header { New-UDHeading -Size 4 -Text "Modal" } -Content { New-UDButton -Text 'Hide Modal' -OnClick { Hide-UDModal } } -Persistent }</dev:code> <dev:remarks> <maml:para>Shows a persistent modal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------------- Custom Width -------------------------</maml:title> <dev:code>New-UDButton -Text "Show Modal" -OnClick { Show-UDModal -Header { New-UDHeading -Size 4 -Text "Modal" } -Content { New-UDButton -Text 'Hide Modal' -OnClick { Hide-UDModal } } -Width 1000 -Height 1000 }</dev:code> <dev:remarks> <maml:para>Shows a custom width modal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-UDToast</command:name> <command:verb>Show</command:verb> <command:noun>UDToast</command:noun> <maml:description> <maml:para>Shows a new toast message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Shows a new toast message.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-UDToast</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color for the toast message.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Balloon</maml:name> <maml:Description> <maml:para>Whether the toast is a balloon format.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Sends a toast to all connected clients.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CloseOnClick</maml:name> <maml:Description> <maml:para>Whether the close the toast on click.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CloseOnEscape</maml:name> <maml:Description> <maml:para>Whether to close the toast on escape.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>The number of milliseconds to show the toast message.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HideCloseButton</maml:name> <maml:Description> <maml:para>Whether to hide the close button.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background color for the toast message.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor</command:parameterValue> <dev:type> <maml:name>DashboardColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Balloon</maml:name> <maml:Description> <maml:para>Whether the toast is a balloon format.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Sends a toast to all connected clients.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CloseOnClick</maml:name> <maml:Description> <maml:para>Whether the close the toast on click.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CloseOnEscape</maml:name> <maml:Description> <maml:para>Whether to close the toast on escape.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>The number of milliseconds to show the toast message.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HideCloseButton</maml:name> <maml:Description> <maml:para>Whether to hide the close button.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Icon</maml:name> <maml:Description> <maml:para>The icon to show in the toast message. </maml:para> <maml:para>```yaml Type: FontAwesomeIcons Parameter Sets: (All) Aliases: Accepted values: None, ad, address_book, address_card, adjust, air_freshener, align_center, align_justify, align_left, align_right, allergies, ambulance, american_sign_language_interpreting, anchor, angle_double_down, angle_double_left, angle_double_right, angle_double_up, angle_down, angle_left, angle_right, angle_up, angry, ankh, apple_alt, archive, archway, arrow_alt_circle_down, arrow_alt_circle_left, arrow_alt_circle_right, arrow_alt_circle_up, arrow_circle_down, arrow_circle_left, arrow_circle_right, arrow_circle_up, arrow_down, arrow_left, arrow_right, arrows_alt, arrows_alt_h, arrows_alt_v, arrow_up, assistive_listening_systems, asterisk, at, atlas, atom, audio_description, award, baby, baby_carriage, backspace, backward, balance_scale, ban, band_aid, barcode, bars, baseball_ball, basketball_ball, bath, battery_empty, battery_full, battery_half, battery_quarter, battery_three_quarters, bed, beer, bell, bell_slash, bezier_curve, bible, bicycle, binoculars, biohazard, birthday_cake, blender, blender_phone, blind, blog, bold, bolt, bomb, bone, bong, book, book_dead, bookmark, book_open, book_reader, bowling_ball, box, boxes, box_open, braille, brain, briefcase, briefcase_medical, broadcast_tower, broom, brush, bug, building, bullhorn, bullseye, burn, bus, bus_alt, business_time, calculator, calendar, calendar_alt, calendar_check, calendar_day, calendar_minus, calendar_plus, calendar_times, calendar_week, camera, camera_retro, campground, candy_cane, cannabis, capsules, car, car_alt, car_battery, car_crash, caret_down, caret_left, caret_right, caret_square_down, caret_square_left, caret_square_right, caret_square_up, caret_up, carrot, car_side, cart_arrow_down, cart_plus, cash_register, cat, certificate, chair, chalkboard, chalkboard_teacher, charging_station, chart_area, chart_bar, chart_line, chart_pie, check, check_circle, check_double, check_square, chess, chess_bishop, chess_board, chess_king, chess_knight, chess_pawn, chess_queen, chess_rook, chevron_circle_down, chevron_circle_left, chevron_circle_right, chevron_circle_up, chevron_down, chevron_left, chevron_right, chevron_up, child, church, circle, circle_notch, city, clipboard, clipboard_check, clipboard_list, clock, clone, closed_captioning, cloud, cloud_download_alt, cloud_meatball, cloud_moon, cloud_moon_rain, cloud_rain, cloud_showers_heavy, cloud_sun, cloud_sun_rain, cloud_upload_alt, cocktail, code, code_branch, coffee, cog, cogs, coins, columns, comment, comment_alt, comment_dollar, comment_dots, comments, comments_dollar, comment_slash, compact_disc, compass, compress, compress_arrows_alt, concierge_bell, cookie, cookie_bite, copy, copyright, couch, credit_card, crop, crop_alt, cross, crosshairs, crow, crown, cube, cubes, cut, database, deaf, democrat, desktop, dharmachakra, diagnoses, dice, dice_d20, dice_d6, dice_five, dice_four, dice_one, dice_six, dice_three, dice_two, digital_tachograph, directions, divide, dizzy, dna, dog, dollar_sign, dolly, dolly_flatbed, donate, door_closed, door_open, dot_circle, dove, download, drafting_compass, dragon, draw_polygon, drum, drum_steelpan, drumstick_bite, dumbbell, dumpster, dumpster_fire, dungeon, edit, eject, ellipsis_h, ellipsis_v, envelope, envelope_open, envelope_open_text, envelope_square, equals, eraser, ethernet, euro_sign, exchange_alt, exclamation, exclamation_circle, exclamation_triangle, expand, expand_arrows_alt, external_link_alt, external_link_square_alt, eye, eye_dropper, eye_slash, fast_backward, fast_forward, fax, feather, feather_alt, female, fighter_jet, file, file_alt, file_archive, file_audio, file_code, file_contract, file_csv, file_download, file_excel, file_export, file_image, file_import, file_invoice, file_invoice_dollar, file_medical, file_medical_alt, file_pdf, file_powerpoint, file_prescription, file_signature, file_upload, file_video, file_word, fill, fill_drip, film, filter, fingerprint, fire, fire_alt, fire_extinguisher, first_aid, fish, fist_raised, flag, flag_checkered, flag_usa, flask, flushed, folder, folder_minus, folder_open, folder_plus, font, font_awesome_logo_full, football_ball, forward, frog, frown, frown_open, funnel_dollar, futbol, gamepad, gas_pump, gavel, gem, genderless, ghost, gift, gifts, glass_cheers, glasses, glass_martini, glass_martini_alt, glass_whiskey, globe, globe_africa, globe_americas, globe_asia, globe_europe, golf_ball, gopuram, graduation_cap, greater_than, greater_than_equal, grimace, grin, grin_alt, grin_beam, grin_beam_sweat, grin_hearts, grin_squint, grin_squint_tears, grin_stars, grin_tears, grin_tongue, grin_tongue_squint, grin_tongue_wink, grin_wink, grip_horizontal, grip_lines, grip_lines_vertical, grip_vertical, guitar, hammer, hamsa, hand_holding, hand_holding_heart, hand_holding_usd, hand_lizard, hand_paper, hand_peace, hand_point_down, hand_pointer, hand_point_left, hand_point_right, hand_point_up, hand_rock, hands, hand_scissors, handshake, hands_helping, hand_spock, hanukiah, hashtag, hat_wizard, haykal, hdd, heading, headphones, headphones_alt, headset, heart, heartbeat, heart_broken, helicopter, highlighter, hiking, hippo, history, hockey_puck, holly_berry, home, horse, horse_head, hospital, hospital_alt, hospital_symbol, hotel, hot_tub, hourglass, hourglass_end, hourglass_half, hourglass_start, house_damage, hryvnia, h_square, icicles, i_cursor, id_badge, id_card, id_card_alt, igloo, image, images, inbox, indent, industry, infinity, info, info_circle, italic, jedi, joint, journal_whills, kaaba, key, keyboard, khanda, kiss, kiss_beam, kiss_wink_heart, kiwi_bird, landmark, language, laptop, laptop_code, laugh, laugh_beam, laugh_squint, laugh_wink, layer_group, leaf, lemon, less_than, less_than_equal, level_down_alt, level_up_alt, life_ring, lightbulb, link, lira_sign, list, list_alt, list_ol, list_ul, location_arrow, lock, lock_open, long_arrow_alt_down, long_arrow_alt_left, long_arrow_alt_right, long_arrow_alt_up, low_vision, luggage_cart, magic, magnet, mail_bulk, male, map, map_marked, map_marked_alt, map_marker, map_marker_alt, map_pin, map_signs, marker, mars, mars_double, mars_stroke, mars_stroke_h, mars_stroke_v, mask, medal, medkit, meh, meh_blank, meh_rolling_eyes, memory, menorah, mercury, meteor, microchip, microphone, microphone_alt, microphone_alt_slash, microphone_slash, microscope, minus, minus_circle, minus_square, mitten, mobile, mobile_alt, money_bill, money_bill_alt, money_bill_wave, money_bill_wave_alt, money_check, money_check_alt, monument, moon, mortar_pestle, mosque, motorcycle, mountain, mouse_pointer, mug_hot, music, network_wired, neuter, newspaper, not_equal, notes_medical, object_group, object_ungroup, oil_can, om, otter, outdent, paint_brush, paint_roller, palette, pallet, paperclip, paper_plane, parachute_box, paragraph, parking, passport, pastafarianism, paste, pause, pause_circle, paw, peace, pen, pen_alt, pencil_alt, pencil_ruler, pen_fancy, pen_nib, pen_square, people_carry, percent, percentage, person_booth, phone, phone_slash, phone_square, phone_volume, piggy_bank, pills, place_of_worship, plane, plane_arrival, plane_departure, play, play_circle, plug, plus, plus_circle, plus_square, podcast, poll, poll_h, poo, poop, poo_storm, portrait, pound_sign, power_off, pray, praying_hands, prescription, prescription_bottle, prescription_bottle_alt, print, procedures, project_diagram, puzzle_piece, qrcode, question, question_circle, quidditch, quote_left, quote_right, quran, radiation, radiation_alt, rainbow, random, receipt, recycle, redo, redo_alt, registered, reply, reply_all, republican, restroom, retweet, ribbon, ring, road, robot, rocket, route, rss, rss_square, ruble_sign, ruler, ruler_combined, ruler_horizontal, ruler_vertical, running, rupee_sign, sad_cry, sad_tear, satellite, satellite_dish, save, school, screwdriver, scroll, sd_card, search, search_dollar, search_location, search_minus, search_plus, seedling, server, shapes, share, share_alt, share_alt_square, share_square, shekel_sign, shield_alt, ship, shipping_fast, shoe_prints, shopping_bag, shopping_basket, shopping_cart, shower, shuttle_van, sign, signal, signature, sign_in_alt, sign_language, sign_out_alt, sim_card, sitemap, skating, skiing, skiing_nordic, skull, skull_crossbones, slash, sleigh, sliders_h, smile, smile_beam, smile_wink, smog, smoking, smoking_ban, sms, snowboarding, snowflake, snowman, snowplow, socks, solar_panel, sort, sort_alpha_down, sort_alpha_up, sort_amount_down, sort_amount_up, sort_down, sort_numeric_down, sort_numeric_up, sort_up, spa, space_shuttle, spider, spinner, splotch, spray_can, square, square_full, square_root_alt, stamp, star, star_and_crescent, star_half, star_half_alt, star_of_david, star_of_life, step_backward, step_forward, stethoscope, sticky_note, stop, stop_circle, stopwatch, store, store_alt, stream, street_view, strikethrough, stroopwafel, subscript, subway, suitcase, suitcase_rolling, sun, superscript, surprise, swatchbook, swimmer, swimming_pool, synagogue, sync, sync_alt, syringe, table, tablet, tablet_alt, table_tennis, tablets, tachometer_alt, tag, tags, tape, tasks, taxi, teeth, teeth_open, temperature_high, temperature_low, tenge, terminal, text_height, text_width, th, theater_masks, thermometer, thermometer_empty, thermometer_full, thermometer_half, thermometer_quarter, thermometer_three_quarters, th_large, th_list, thumbs_down, thumbs_up, thumbtack, ticket_alt, times, times_circle, tint, tint_slash, tired, toggle_off, toggle_on, toilet, toilet_paper, toolbox, tools, tooth, torah, torii_gate, tractor, trademark, traffic_light, train, tram, transgender, transgender_alt, trash, trash_alt, tree, trophy, truck, truck_loading, truck_monster, truck_moving, truck_pickup, tshirt, tty, tv, umbrella, umbrella_beach, underline, undo, undo_alt, universal_access, university, unlink, unlock, unlock_alt, upload, user, user_alt, user_alt_slash, user_astronaut, user_check, user circle, user_clock, user_cog, user_edit, user_friends, user_graduate, user_injured, user_lock, user_md, user_minus, user_ninja, user_plus, users, users_cog, user_secret, user_shield, user_slash, user_tag, user_tie, user_times, utensils, utensil_spoon, vector_square, venus, venus_double, venus_mars, vial, vials, video, video_slash, vihara, volleyball_ball, volume_down, volume_mute, volume_off, volume_up, vote_yea, vr_cardboard, walking, wallet, warehouse, water, weight, weight_hanging, wheelchair, wifi, wind, window_close, window_maximize, window_minimize, window_restore, wine_bottle, wine_glass, wine_glass_alt, won_sign, wrench, x_ray, yen_sign, yin_yang, _500px, accessible_icon, accusoft, acquisitions_incorporated, adn, adobe, adversal, affiliatetheme, algolia, alipay, amazon, amazon_pay, amilia, android, angellist, angrycreative, angular, apper, apple, apple_pay, app_store, app_store_ios, artstation, asymmetrik, atlassian, audible, autoprefixer, avianex, aviato, aws, bandcamp, behance, behance_square, bimobject, bitbucket, bitcoin, bity, blackberry, black_tie, blogger, blogger_b, bluetooth, bluetooth_b, btc, buromobelexperte, buysellads, canadian_maple_leaf, cc_amazon_pay, cc_amex, cc_apple_pay, cc_diners_club, cc_discover, cc_jcb, cc_mastercard, cc_paypal, cc_stripe, cc_visa, centercode, centos, chrome, cloudscale, cloudsmith, cloudversify, codepen, codiepie, confluence, connectdevelop, contao, cpanel, creative_commons, creative_commons_by, creative_commons_nc, creative_commons_nc_eu, creative_commons_nc_jp, creative_commons_nd, creative_commons_pd, creative_commons_pd_alt, creative_commons_remix, creative_commons_sa, creative_commons_sampling, creative_commons_sampling_plus, creative_commons_share, creative_commons_zero, critical_role, css3, css3_alt, cuttlefish, d_and_d, d_and_d_beyond, dashcube, delicious, deploydog, deskpro, dev, deviantart, dhl, diaspora, digg, digital_ocean, discord, discourse, dochub, docker, draft2digital, dribbble, dribbble_square, dropbox, drupal, dyalog, earlybirds, ebay, edge, elementor, ello, ember, empire, envira, erlang, ethereum, etsy, expeditedssl, facebook, facebook_f, facebook_messenger, facebook_square, fantasy_flight_games, fedex, fedora, figma, firefox, firstdraft, first_order, first_order_alt, flickr, flipboard, fly, font_awesome, font_awesome_alt, font_awesome_flag, fonticons, fonticons_fi, fort_awesome, fort_awesome_alt, forumbee, foursquare, freebsd, free_code_camp, fulcrum, galactic_republic, galactic_senate, get_pocket, gg, gg_circle, git, github, github_alt, github_square, gitkraken, gitlab, git_square, gitter, glide, glide_g, gofore, goodreads, goodreads_g, google, google_drive, google_play, google_plus, google_plus_g, google_plus_square, google_wallet, gratipay, grav, gripfire, grunt, gulp, hacker_news, hacker_news_square, hackerrank, hips, hire_a_helper, hooli, hornbill, hotjar, houzz, html5, hubspot, imdb, instagram, intercom, internet_explorer, invision, ioxhost, itunes, itunes_note, java, jedi_order, jenkins, jira, joget, joomla, js, jsfiddle, js_square, kaggle, keybase, keycdn, kickstarter, kickstarter_k, korvue, laravel, lastfm, lastfm_square, leanpub, less, line, linkedin, linkedin_in, linode, linux, lyft, magento, mailchimp, mandalorian, markdown, mastodon, maxcdn, medapps, medium, medium_m, medrt, meetup, megaport, mendeley, microsoft, mix, mixcloud, mizuni, modx, monero, napster, neos, nimblr, nintendo_switch, node, node_js, npm, ns8, nutritionix, odnoklassniki, odnoklassniki_square, old_republic, opencart, openid, opera, optin_monster, osi, page4, pagelines, palfed, patreon, paypal, penny_arcade, periscope, phabricator, phoenix_framework, phoenix_squadron, php, pied_piper, pied_piper_alt, pied_piper_hat, pied_piper_pp, pinterest, pinterest_p, pinterest_square, playstation, product_hunt, pushed, python, qq, quinscape, quora, raspberry_pi, ravelry, react, reacteurope, readme, rebel, reddit, reddit_alien, reddit_square, redhat, red_river, renren, replyd, researchgate, resolving, rev, rocketchat, rockrms, r_project, safari, sass, schlix, scribd, searchengin, sellcast, sellsy, servicestack, shirtsinbulk, shopware, simplybuilt, sistrix, sith, sketch, skyatlas, skype, slack, slack_hash, slideshare, snapchat, snapchat_ghost, snapchat_square, soundcloud, sourcetree, speakap, spotify, squarespace, stack_exchange, stack_overflow, staylinked, steam, steam_square, steam_symbol, sticker_mule, strava, stripe, stripe_s, studiovinari, stumbleupon, stumbleupon_circle, superpowers, supple, suse, teamspeak, telegram, telegram_plane, tencent_weibo, themeco, themeisle, the_red_yeti, think_peaks, trade_federation, trello, tripadvisor, tumblr, tumblr_square, twitch, twitter, twitter_square, typo3, uber, ubuntu, uikit, uniregistry, untappd, ups, usb, usps, ussunnah, vaadin, viacoin, viadeo, viadeo_square, viber, vimeo, vimeo_square, vimeo_v, vine, vk, vnv, vuejs, weebly, weibo, weixin, whatsapp, whatsapp_square, whmcs, wikipedia_w, windows, wix, wizards_of_the_coast, wolf_pack_battalion, wordpress, wordpress_simple, wpbeginner, wpexplorer, wpforms, wpressr, xbox, xing, xing_square, yahoo, yandex, yandex_international, yarn, y_combinator, yelp, yoast, youtube, youtube_square, zhihu, address_book_o, address_card_o, vcard_o, vcard, signing, asl_interpreting, arrow_circle_o_down, arrow_circle_o_left, arrow_circle_o_right, arrow_circle_o_up, arrows, arrows_h, arrows_v, reorder, navicon, bathtub, s15, battery_0, battery, battery_4, battery_2, battery_1, battery_3, bell_o, bell_slash_o, flash, bookmark_o, building_o, calendar_o, calendar_check_o, calendar_minus_o, calendar_plus_o, calendar_times_o, automobile, caret_square_o_down, caret_square_o_left, caret_square_o_right, toggle_down, toggle_left, toggle_right, caret_square_o_up, toggle_up, area_chart, bar_chart_o, bar_chart, line_chart, pie_chart, check_circle_o, check_square_o, circle_o, circle_thin, circle_o_notch, clock_o, cloud_download, cloud_upload, code_fork, gear, gears, comment_o, commenting, commenting_o, comments_o, files_o, credit_card_alt, cc, scissors, deafness, hard_of_hearing, usd, dollar, dot_circle_o, envelope_o, envelope_open_o, euro, eur, exchange, warning, external_link_square, external_link, eyedropper, file_o, file_text_o, file_text, file_zip_o, file_archive_o, file_audio_o, file_sound_o, file_code_o, file_excel_o, file_photo_o, file_picture_o, file_image_o, file_pdf_o, file_powerpoint_o, file_movie_o, file_video_o, file_word_o, flag_o, folder_o, folder_open_o, frown_o, futbol_o, soccer_ball_o, legal, diamond, mortar_board, hand_lizard_o, hand_paper_o, hand_stop_o, hand_peace_o, hand_o_down, hand_pointer_o, hand_o_left, hand_o_right, hand_o_up, hand_rock_o, hand_grab_o, hand_scissors_o, handshake_o, hand_spock_o, hdd_o, header, heart_o, hospital_o, hourglass_o, hourglass_1, hourglass_2, hourglass_3, drivers_license_o, drivers_license, id_card_o, photo, picture_o, keyboard_o, lemon_o, level_down, level_up, life_bouy, life_buoy, support, life_saver, lightbulb_o, chain, turkish_lira, _try, long_arrow_down, long_arrow_left, long_arrow_right, long_arrow_up, map_o, meh_o, minus_square_o, money, moon_o, newspaper_o, dedent, send, paper_plane_o, send_o, pause_circle_o, pencil_square, pencil_square_o, pencil, mobile_phone, volume_control_phone, bank, plus_square_o, play_circle_o, gbp, question_circle_o, rotate_right, repeat, mail_reply, mail_reply_all, feed, rouble, ruble, rub, inr, rupee, floppy_o, mail_forward, share_square_o, ils, shekel, sheqel, shield, sign_in, sign_out, sliders, smile_o, snowflake_o, unsorted, sort_alpha_asc, sort_alpha_desc, sort_amount_asc, sort_amount_desc, sort_asc, sort_numeric_asc, sort_numeric_desc, sort_desc, square_o, star_o, star_half_empty, star_half_o, star_half_full, sticky_note_o, stop_circle_o, sun_o, refresh, tachometer, dashboard, cab, thermometer_0, thermometer_4, thermometer_2, thermometer_1, thermometer_3, thumb_tack, thumbs_o_down, thumbs_o_up, ticket, times_rectangle, remove, times_rectangle_o, times_circle_o, intersex, trash_o, television, rotate_left, institution, chain_broken, user_o, user_circle_o, group, cutlery, spoon, wheelchair_alt, window_close_o, close, glass, won, krw, cny, jpy, yen, rmb, bitbucket_square, ge, facebook_official, fa, google_plus_official, google_plus_circle, gittip, linkedin_square, ra, resistance, eercast, yc, y_combinator_square, yc_square, youtube_play</maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -IconColor</maml:para> <maml:para>The color of the icon.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: DashboardColor Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -Id</maml:para> <maml:para>The ID of the toast message.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -Message</maml:para> <maml:para>The message to show within the toast message.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: True Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -MessageColor</maml:para> <maml:para>The font color of the message.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: DashboardColor Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -MessageSize</maml:para> <maml:para>The size of the message.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -Overlay</maml:para> <maml:para>Whether to display an overlay.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -OverlayClose</maml:para> <maml:para></maml:para> <maml:para>yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -OverlayColor</maml:para> <maml:para>The color of the overlay.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: DashboardColor Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -Position</maml:para> <maml:para>The position of the toast.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: Accepted values: bottomRight, bottomLeft, topRight, topLeft, topCenter, bottomCenter, center</maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -ReplaceToast</maml:para> <maml:para>Whether to replace an existing toast.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -RightToLeft</maml:para> <maml:para>Whether the toast should be formatted right to left.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -Theme</maml:para> <maml:para>Light or dark theme.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: Accepted values: light, dark</maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -Title</maml:para> <maml:para>The title of the toast.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -TitleColor</maml:para> <maml:para>The font color of the title.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: DashboardColor Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -TitleSize</maml:para> <maml:para>The size of the title.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -TransitionIn</maml:para> <maml:para>How to transition the toast into the page.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: Accepted values: bounceInLeft, bounceInRight, bounceInUp, bounceInDown, fadeIn, fadeInDown, fadeInUp, fadeInLeft, fadeInRight, flipInX</maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False</maml:para> <maml:para></maml:para> <maml:para>### -TransitionOut</maml:para> <maml:para>How to transition the toast out of the page.</maml:para> <maml:para></maml:para> <maml:para>yaml Type: String Parameter Sets: (All) Aliases: Accepted values: bounceInLeft, bounceInRight, bounceInUp, bounceInDown, fadeIn, fadeInDown, fadeInUp, fadeInLeft, fadeInRight, flipInX</maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------------- Basic toast -------------------------</maml:title> <dev:code>New-UDButton -Text "Show Toast" -OnClick { Show-UDToast -Message 'Toast' }</dev:code> <dev:remarks> <maml:para>Shows a basic toast.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=217032</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-UDDashboard</command:name> <command:verb>Start</command:verb> <command:noun>UDDashboard</command:noun> <maml:description> <maml:para>Starts a dashboard defined by New-UDDashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a dashboard defined by New-UDDashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoReload</maml:name> <maml:Description> <maml:para>Reloads the dashboard automatically when changes are made to the script containing the dashboard. The dashboard must be saved as a file.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>The certificate to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>The certificate file to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFilePassword</maml:name> <maml:Description> <maml:para>The certificate file password to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>A ScriptBlock that calls New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableTelemetry</maml:name> <maml:Description> <maml:para>{{Fill DisableTelemetry Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An array of REST endpoints to expose with this dashboard. They can be generated with New-UDEndpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Endpoint[]</command:parameterValue> <dev:type> <maml:name>Endpoint[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Starts a dashboard and stops any dashboard running on the same port.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HttpsPort</maml:name> <maml:Description> <maml:para>The HTTPS port to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListenAddress</maml:name> <maml:Description> <maml:para>The IP Addresses to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port to use for the dashboard. Defaults to 80.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishedFolder</maml:name> <maml:Description> <maml:para>A collection of published folders. You can generate these folders with Publish-UDFolder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PublishedFolder[]</command:parameterValue> <dev:type> <maml:name>PublishedFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>A token used to authenticate update requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>Blocks execution and waits for the web server to run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoReload</maml:name> <maml:Description> <maml:para>Reloads the dashboard automatically when changes are made to the script containing the dashboard. The dashboard must be saved as a file.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>The certificate to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>The certificate file to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFilePassword</maml:name> <maml:Description> <maml:para>The certificate file password to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dashboard</maml:name> <maml:Description> <maml:para>The dashboard to start. This dashboard is created with New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dashboard</command:parameterValue> <dev:type> <maml:name>Dashboard</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableTelemetry</maml:name> <maml:Description> <maml:para>{{Fill DisableTelemetry Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An array of REST endpoints to expose with this dashboard. They can be generated with New-UDEndpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Endpoint[]</command:parameterValue> <dev:type> <maml:name>Endpoint[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Starts a dashboard and stops any dashboard running on the same port.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HttpsPort</maml:name> <maml:Description> <maml:para>The HTTPS port to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListenAddress</maml:name> <maml:Description> <maml:para>The IP Addresses to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port to use for the dashboard. Defaults to 80.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishedFolder</maml:name> <maml:Description> <maml:para>A collection of published folders. You can generate these folders with Publish-UDFolder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PublishedFolder[]</command:parameterValue> <dev:type> <maml:name>PublishedFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>A token used to authenticate update requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>Blocks execution and waits for the web server to run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoReload</maml:name> <maml:Description> <maml:para>Reloads the dashboard automatically when changes are made to the script containing the dashboard. The dashboard must be saved as a file.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>The certificate to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>The certificate file to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFilePassword</maml:name> <maml:Description> <maml:para>The certificate file password to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableTelemetry</maml:name> <maml:Description> <maml:para>{{Fill DisableTelemetry Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An array of REST endpoints to expose with this dashboard. They can be generated with New-UDEndpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Endpoint[]</command:parameterValue> <dev:type> <maml:name>Endpoint[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>The path to a file that returns a dashboard. This file should return a dashboard with New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Starts a dashboard and stops any dashboard running on the same port.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HttpsPort</maml:name> <maml:Description> <maml:para>The HTTPS port to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListenAddress</maml:name> <maml:Description> <maml:para>The IP Addresses to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port to use for the dashboard. Defaults to 80.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishedFolder</maml:name> <maml:Description> <maml:para>A collection of published folders. You can generate these folders with Publish-UDFolder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PublishedFolder[]</command:parameterValue> <dev:type> <maml:name>PublishedFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>A token used to authenticate update requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>Blocks execution and waits for the web server to run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoReload</maml:name> <maml:Description> <maml:para>Reloads the dashboard automatically when changes are made to the script containing the dashboard. The dashboard must be saved as a file.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>The certificate to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>The certificate file to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFilePassword</maml:name> <maml:Description> <maml:para>The certificate file password to use encrypt HTTPS traffic. The webserver will listen on HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>A ScriptBlock that calls New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dashboard</maml:name> <maml:Description> <maml:para>The dashboard to start. This dashboard is created with New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dashboard</command:parameterValue> <dev:type> <maml:name>Dashboard</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableTelemetry</maml:name> <maml:Description> <maml:para>{{Fill DisableTelemetry Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An array of REST endpoints to expose with this dashboard. They can be generated with New-UDEndpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Endpoint[]</command:parameterValue> <dev:type> <maml:name>Endpoint[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>The path to a file that returns a dashboard. This file should return a dashboard with New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Starts a dashboard and stops any dashboard running on the same port.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HttpsPort</maml:name> <maml:Description> <maml:para>The HTTPS port to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListenAddress</maml:name> <maml:Description> <maml:para>The IP Addresses to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port to use for the dashboard. Defaults to 80.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishedFolder</maml:name> <maml:Description> <maml:para>A collection of published folders. You can generate these folders with Publish-UDFolder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PublishedFolder[]</command:parameterValue> <dev:type> <maml:name>PublishedFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>A token used to authenticate update requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>Blocks execution and waits for the web server to run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-UDDashboard -Content { New-UDDashboard -Title "Groovy Dashboard" }</dev:code> <dev:remarks> <maml:para>Starts a new dashboard based on the specified ScriptBlock with the title Groovy Dashboard on port 80.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Dashboard = New-UDDashboard -Title "Groovy Dashboard" PS C:\> Start-UDDashboard -Dashboard $Dashboard -Port 1000</dev:code> <dev:remarks> <maml:para>Starts a new dashboard based on the specified dashboard created by New-Dashboard with the title Groovy Dashboard on port 1000.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Start-UDDashboard -Name "MyDashboard" -Content { New-UDDashboard -Title "Groovy Dashboard" }</dev:code> <dev:remarks> <maml:para>Starts a new dashboard with the name "MyDashboard".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-UDRestApi</command:name> <command:verb>Start</command:verb> <command:noun>UDRestApi</command:noun> <maml:description> <maml:para>Starts a REST API server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a REST API server. This server consists only of REST endpoints. Unlike Start-UDDashboard, this type of server has no user interface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-UDRestApi</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoReload</maml:name> <maml:Description> <maml:para>Whether to AutoReload this REST API on changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Certificate for HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>Certificate file for HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFilePassword</maml:name> <maml:Description> <maml:para>Certificate file password for HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableTelemetry</maml:name> <maml:Description> <maml:para>Disables telemetry collection.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An array of endpoints created with New-UDEndpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Endpoint[]</command:parameterValue> <dev:type> <maml:name>Endpoint[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointInitialization</maml:name> <maml:Description> <maml:para>The initial session state for endpoints of this dashboard. Use New-UDEndpointInitialization to create an object for this parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue> <dev:type> <maml:name>InitialSessionState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Starts a REST API and stops any servers listening on that port.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListenAddress</maml:name> <maml:Description> <maml:para>The IP Address to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the REST API server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port the REST API server listens on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishedFolder</maml:name> <maml:Description> <maml:para>A collection of published folders. You can generate these folders with Publish-UDFolder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PublishedFolder[]</command:parameterValue> <dev:type> <maml:name>PublishedFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>This causes this cmdlet to block the terminal.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoReload</maml:name> <maml:Description> <maml:para>Whether to AutoReload this REST API on changes.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Certificate for HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>Certificate file for HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFilePassword</maml:name> <maml:Description> <maml:para>Certificate file password for HTTPS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableTelemetry</maml:name> <maml:Description> <maml:para>Disables telemetry collection.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>An array of endpoints created with New-UDEndpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Endpoint[]</command:parameterValue> <dev:type> <maml:name>Endpoint[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointInitialization</maml:name> <maml:Description> <maml:para>The initial session state for endpoints of this dashboard. Use New-UDEndpointInitialization to create an object for this parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue> <dev:type> <maml:name>InitialSessionState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Starts a REST API and stops any servers listening on that port.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListenAddress</maml:name> <maml:Description> <maml:para>The IP Address to listen on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the REST API server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port the REST API server listens on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishedFolder</maml:name> <maml:Description> <maml:para>A collection of published folders. You can generate these folders with Publish-UDFolder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PublishedFolder[]</command:parameterValue> <dev:type> <maml:name>PublishedFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>This causes this cmdlet to block the terminal.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-UDRestApi -Port 1000 -Endpoint @( New-UDEndpoint -Url "user" -Method "GET" -Endpoint { @("Adam", "Sarah", "Bill") | ConvertTo-Json } ) Invoke-RestMethod http://localhost:1000/api/user</dev:code> <dev:remarks> <maml:para>Starts a new REST API with a "user" endpoint that returns Adam, Sarah and Bill as a JSON array.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-UDDashboard</command:name> <command:verb>Stop</command:verb> <command:noun>UDDashboard</command:noun> <maml:description> <maml:para>Stops a dashboard returned by Start-UDDashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops a dashboard returned by Start-UDDashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-UDDashboard</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the dashboard to stop.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-UDDashboard</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Stops the dashboard by port number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-UDDashboard</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>The dashboard server to stop. This is returned by Start-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Server</command:parameterValue> <dev:type> <maml:name>Server</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the dashboard to stop.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Stops the dashboard by port number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>The dashboard server to stop. This is returned by Start-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Server</command:parameterValue> <dev:type> <maml:name>Server</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $DashboardServer = Start-UDDashboard -Content { New-UDDashboard {} } PS C:\> Stop-UDDashboard -Server $DashboardServer</dev:code> <dev:remarks> <maml:para>Stops a dashboard returned by Start-UDDashboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Stop-UDDashboard -Name "MyDashboard"</dev:code> <dev:remarks> <maml:para>Stops the dashboard named "MyDashboard".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-UDRestApi</command:name> <command:verb>Stop</command:verb> <command:noun>UDRestApi</command:noun> <maml:description> <maml:para>Stops a REST API server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops a REST API server started with Start-UDRestApi</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-UDRestApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the REST API server to stop.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-UDRestApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>The server object to stop. This is returned by Get-UDRestApi and Start-UDRestApi.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Server</command:parameterValue> <dev:type> <maml:name>Server</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the REST API server to stop.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>The server object to stop. This is returned by Get-UDRestApi and Start-UDRestApi.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Server</command:parameterValue> <dev:type> <maml:name>Server</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UniversalDashboard.Server</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UDRestApi | Stop-UDRestApi</dev:code> <dev:remarks> <maml:para>Stops all running REST API servers.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Sync-UDElement</command:name> <command:verb>Sync</command:verb> <command:noun>UDElement</command:noun> <maml:description> <maml:para>Forces an element to update its state.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Forces an element to update its state. This only works with elements (charts, monitors, counters, elements, etc) that have used the Endpoint parameter and not the content parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Sync-UDElement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Whether to broadcast this change to all connected clients.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The element to force to update .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Broadcast</maml:name> <maml:Description> <maml:para>Whether to broadcast this change to all connected clients.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The element to force to update .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-UDButton -Text "Button" -Id "Button" -OnClick { $Session:Clicked = $true Sync-UDElement -Id 'Counter' } New-UDCounter -Title "Counter" -Id "Counter" -Endpoint { if ($Session:Clicked) { 1 } else { 0 } }</dev:code> <dev:remarks> <maml:para>Forces the counter to update its state when the button is clicked.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-UDDashboard</command:name> <command:verb>Update</command:verb> <command:noun>UDDashboard</command:noun> <maml:description> <maml:para>Updates a running dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a running dashboard. To be able to support this cmdlet you need to specify the UpdateToken parameter on Start-UDDashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowTLs10</maml:name> <maml:Description> <maml:para>Allows TLS 1.0 for the web request.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the dashboard to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>The update token for the dashboard. This is specified with Start-UDDashboard. Treat this as a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the running Universal Dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-UDDashboard</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowTLs10</maml:name> <maml:Description> <maml:para>Allows TLS 1.0 for the web request.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>The file path of a PS1 that returns a New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>The update token for the dashboard. This is specified with Start-UDDashboard. Treat this as a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the running Universal Dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowTLs10</maml:name> <maml:Description> <maml:para>Allows TLS 1.0 for the web request.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The content of the dashboard to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>The file path of a PS1 that returns a New-UDDashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateToken</maml:name> <maml:Description> <maml:para>The update token for the dashboard. This is specified with Start-UDDashboard. Treat this as a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the running Universal Dashboard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-UDDashboard -UpdateToken 1234 -Port 8080 PS C:\> Update-UDDashboard -UpdateToken 1234 -Url http://localhost:8080 -Content { New-UDDashboard -Title "Updated" -Content { New-UDCard -TItle "Updated Content" } }</dev:code> <dev:remarks> <maml:para>Starts a dashboard and updates it using Update-UDDashboard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Write-UDLog</command:name> <command:verb>Write</command:verb> <command:noun>UDLog</command:noun> <maml:description> <maml:para>Writes a log messge to the Universal Dashboard log.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Writes a log messge to the Universal Dashboard log. This can be helpful for debugging endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Write-UDLog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to log.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The log level for this log message.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggerName</maml:name> <maml:Description> <maml:para>The name of the logger. This is useful for grouping log messages together.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The log level for this log message.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggerName</maml:name> <maml:Description> <maml:para>The name of the logger. This is useful for grouping log messages together.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to log.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Write-UDLog -Level Debug -Message "Test message"</dev:code> <dev:remarks> <maml:para>Writes a debug message to the Universal Dashboard log.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |