Kelverion.BMC.Helix.Itsm.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> <!-- Module: Kelverion.BMC.Helix ITSM Version: 2.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-HelixItsmEntry</command:name> <maml:description> <maml:para>Retrieves requests from BMC Helix ITSM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HelixEntry</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HelixItsmEntry cmdlet retrieves records from Helix ITSM. When used with Kelverion Runbook Studio this cmdlet can be configured to retrieve records that match a collection of filter criteria. Alternatively, this cmdlet can be configured to retrieve requests that match a Helix ITSM query expression.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Query"> <!--NAME: Query--> <maml:name>Get-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies the Helix ITSM query used to determine which requests to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether output the entries in ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number (non-negative) of entries to offset the results by. Used for paginating results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the number (non-negative) of entries to limit the results by. Used for paginating results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field that should be used to order the results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to retrieve instances from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Filters"> <!--NAME: Filters--> <maml:name>Get-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filter to be used to determine which requests to retrieve. Used in conjunction with Kelverion Runbook Studio.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether output the entries in ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number (non-negative) of entries to offset the results by. Used for paginating results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the number (non-negative) of entries to limit the results by. Used for paginating results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field that should be used to order the results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to retrieve instances from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="EntryId"> <!--NAME: EntryId--> <maml:name>Get-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to retrieve instances from.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the Entry IDs of the entries to retrieve.</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 /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default" default="true"> <!--TAG: DEFAULT--> <!--NAME: Default--> <maml:name>Get-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to retrieve instances from.</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 /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies the Helix ITSM query used to determine which requests to retrieve.</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 /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether output the entries in ascending order.</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 /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number (non-negative) of entries to offset the results by. Used for paginating results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the number (non-negative) of entries to limit the results by. Used for paginating results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field that should be used to order the results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to retrieve instances from.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filter to be used to determine which requests to retrieve. Used in conjunction with Kelverion Runbook Studio.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the Entry IDs of the entries to retrieve.</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 /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings representing Entry ID values to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The Get-HelixItsmEntry cmdlet generates objects that represent the entries that were retrieved. The object properties correspond to the fields in the form that was targeted, where the name of the property is the field label used in the form's default view.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Get an entry by its Entry ID.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> $entry = Get-HelixItsmEntry -Connection $connection -Form "HPD:Incident" -EntryId = 000000000123456"</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 2: Get all closed incidents using a query string.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> $entries = Get-HelixItsmEntry -Connection $connection -Form "HPD:Incident" -Query "'Status' = ""Closed"""</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-HelixItsmEntry</command:name> <maml:description> <maml:para> Updates on or more entries in a Helix ITSM form</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>Helix ITSMRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HelixItsmEntry cmdlet updates one or more entries in a Helix ITSM form. New field values are specified using a hash table, where the keys correspond to the fields that you want to update.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="EntryId"> <!--NAME: EntryId--> <maml:name>Set-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the ID of the request to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies updated field values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to update the request in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject" default="true"> <!--TAG: DEFAULT--> <!--NAME: InputObject--> <maml:name>Set-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to update the request in.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entries that you want to update. Each entry must contain a property that corresponds to the Entry ID of the form that you are removing the entries from. The default name for this field is typically "Request ID"</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 /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the EntryId of the request 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies updated field values.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to update the request in.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entries that you want to update. Each entry must contain a property that corresponds to the Entry ID of the form that you are removing the entries from. The default name for this field is typically "Request ID"</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 /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects representing request entries to this cmdlet. The object must have a property that corresponds to the Entry ID field in the form you are updating. For the the Entry ID property you may use the name of the Entry ID field or the label assigned to the the Entry ID field in the default view as defined in your Helix ITSM instance.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The Set-HelixItsmEntry cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Update an entry by its Entry ID</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> Set-HelixItsmEntry -Connection $connection -Form "HPD:Incident" -EntryId = 000000000123456" -Values @{Status = 'Closed'}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-HelixItsmEntryAttachment</command:name> <maml:description> <maml:para>Uploads an attachment to the specified Helix ITSM request.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>Helix ITSMAttachmentContent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HelixItsmEntryAttachment cmdlet uploads an attachment to the specified Helix ITSM request.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="EntryId"> <!--NAME: EntryId--> <maml:name>Set-HelixItsmEntryAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the name of the attachment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the name of the attachment field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the EntryId of the request to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the content of the attachment as an array of bytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject" default="true"> <!--TAG: DEFAULT--> <!--NAME: InputObject--> <maml:name>Set-HelixItsmEntryAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the name of the attachment.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the name of the attachment field.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request to add the attachment 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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A custom object representing the entry to upload the attachment to. Must contain a property that corresponds to the Entry ID field. The default name for this field is typically "Request ID"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the name of the attachment.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the name of the attachment field.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the EntryId of the request to add the attachment 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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the content of the attachment as an array of bytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request to add the attachment 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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A custom object representing the entry to upload the attachment to. Must contain a property that corresponds to the Entry ID field. The default name for this field is typically "Request ID"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Management.Automation.PSObject</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>You can pipe objects representing request entries to this cmdlet. The object must have a property that corresponds to the Entry ID field in the form you are updating. For the the Entry ID property you may use the name of the Entry ID field or the label assigned to the the Entry ID field in the default view as defined in your Helix ITSM instance.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The Set-HelixItsmEntryAttachment cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Download a file from Azure and upload to an entry attachment</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $content = Get-AzStorageFileContent -ShareName "Share06" -Path "WorkingFolder/CurrentDataFile" PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> Set-HelixItsmEntryAttachment -Connection $connection -Form "HPD:Incident" -EntryId = "000000000123456" -Field "Attachment01" -Content $content</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-HelixItsmEntryAttachment</command:name> <maml:description> <maml:para>Downloads the content BLOB from the specified Helix ITSM Request.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Helix ITSMAttachmentContent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HelixItsmEntryAttachment cmdlet downloads the content BLOB from the specified Helix ITSM request</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="EntryId"> <!--NAME: EntryId--> <maml:name>Get-HelixItsmEntryAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the name of the attachment field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the EntryId of the request to get the attachment from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject" default="true"> <!--TAG: DEFAULT--> <!--NAME: InputObject--> <maml:name>Get-HelixItsmEntryAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the EntryId of the request to get the attachment from.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the name of the attachment field.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A custom object representing the entry to download the attachment from. Must contain a property that corresponds to the Entry ID field. The default name for this field is typically "Request ID"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the name of the attachment field.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the EntryId of the request to get the attachment from.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to Helix ITSM.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A custom object representing the entry to download the attachment from. Must contain a property that corresponds to the Entry ID field. The default name for this field is typically "Request ID"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Management.Automation.PSObject</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>You can pipe objects representing request entries to this cmdlet. The object must have a property that corresponds to the Entry ID field in the form you are updating. For the the Entry ID property you may use the name of the Entry ID field or the label assigned to the the Entry ID field in the default view as defined in your Helix ITSM instance.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>byte[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The Get-HelixItsmEntryAttachment outputs an BLOB that is the binary content of the attachment that was downloaded.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Get the attachment BLOB from an entry attachment field</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> $content = Get-HelixItsmEntryAttachment -Connection $connection -Form "HPD:Incident" -EntryId = "000000000123456" -Field "Attachment01"</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-HelixItsmEntry</command:name> <maml:description> <maml:para>Removes one or more entries from a Helix ITSM form.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>Helix ITSMRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HelixItsmEntry cmdlet removes one or more entries from a Helix ITSM form.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="EntryId"> <!--NAME: EntryId--> <maml:name>Remove-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the Entry IDs of the request 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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to a Helix ITSM instance and also the integration module license.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>NoCascade</maml:name> <maml:description> <maml:para>Indicates that you do not want to run the workflow when the entry is removed.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that you want to remove individual entries that are not retrieved from the join schema.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject" default="true"> <!--TAG: DEFAULT--> <!--NAME: InputObject--> <maml:name>Remove-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to a Helix ITSM instance and also the integration module license.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request to be removed.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">InputObject</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies the entries that you want to remove. Each entry must contain a property that corresponds to the Entry ID of the form that you are removing the entries from. The default name for this field is typically "Request ID"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">object[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">object[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>NoCascade</maml:name> <maml:description> <maml:para>Indicates that you do not want to run the workflow when the entry is removed.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that you want to remove individual entries that are not retrieved from the join schema.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Specifies the Entry IDs of the request 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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to a Helix ITSM instance and also the integration module license.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form that contains the request to be removed.</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 /> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">InputObject</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies the entries that you want to remove. Each entry must contain a property that corresponds to the Entry ID of the form that you are removing the entries from. The default name for this field is typically "Request ID"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">object[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">object[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>NoCascade</maml:name> <maml:description> <maml:para>Indicates that you do not want to run the workflow when the entry is removed.</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 /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that you want to remove individual entries that are not retrieved from the join schema.</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 /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Management.Automation.PSObject</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>You can pipe objects representing request entries to this cmdlet. The object must have a property that corresponds to the Entry ID field in the form you are updating. For the the Entry ID property you may use the name of the Entry ID field or the label assigned to the the Entry ID field in the default view as defined in your Helix ITSM instance.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The Remove-HelixItsmEntry cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Remove a request</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> Remove-HelixItsmEntry -Connection $connection -Form "HPD:Incident" -EntryId = 000000000123456"</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-HelixItsmEntry</command:name> <maml:description> <maml:para>Creates a new entry in a Helix ITSM form.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>Helix ITSMRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-HelixItsmEntry cmdlet creates a new entry in the specified form using provided values to initialize the entry.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>New-HelixItsmEntry</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the field values to use to initialize the new entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to a Helix ITSM instance and also the integration module license.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to create the new entry for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the field values to use to initialize the new entry.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to a Helix ITSM instance and also the integration module license.</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 /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""> <maml:name>Form</maml:name> <maml:description> <maml:para>Specifies the name of the Helix ITSM form to create the new entry for.</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 /> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>For regular forms, the New-HelixItsmEntry cmdlet outputs the Entry ID of the entry that was created. For other forms, notably join forms, the New-HelixItsmEntry cmdlet outputs an empty string.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Create a new entry</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = GetAzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccount "Contoso17" -Name "Helix ITSM01" PS C:\> $entryId = Remove-HelixItsmEntry -Connection $connection -Form "TestForm01" -Values @{Submitter = "Tester"; 'Short Description' = "This is a test"}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> </helpItems> |