Kelverion.Atlassian.Jira.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 2018 v2.2.38--> <!-- Module: Kelverion.Atlassian.Jira Version: 2.2 --> <!--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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Add-JiraIssueAttachment</command:name> <maml:description> <maml:para>Add an attachment to an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>JiraIssueAttachment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-JiraIssueAttachment cmdlet adds an attachment to an issue. You can specify the issue by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-JiraIssueAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue that the attachment will be added 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the filename 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the content of the attachment as a byte array.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue that the attachment will be added 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the filename 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the content of the attachment as a byte array.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the ID of the attachment that was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add an error image to an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $content = Get-Content -Path '.\Error.png' PS C:\> Add-JiraIssueAttachment -Connection $connection -IssueKey 'DEV-123' -Content $content -Filename 'Error.png'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Add-JiraIssueComment</command:name> <maml:description> <maml:para>Add a comment to an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>JiraIssueComment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-JiraIssueComment cmdlet adds a comment to an issue You can specify the issue by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-JiraIssueComment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the comment 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies the comment 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the comment is visible. By default the comment will be visible to all users.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the comment 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies the comment 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the comment is visible. By default the comment will be visible to all users.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns the ID of the comment that was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a comment that is visible to all users.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> Add-JiraIssueComment -Connection $connection -IssueKey 'DEV-123' -Comment 'Waiting for customer'</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: Add a comment that is visible to a specific role.</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 = Get-AutomationConnection -Name 'Jira' PS C:\> Add-JiraIssueComment -Connection $connection -IssueKey 'DEV-123' -Comment 'Waiting for customer' -Visibility 'Service Desk Team'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Add-JiraIssueWatcher</command:name> <maml:description> <maml:para>Add users as watchers of an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>JiraIssueWatcher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-JiraIssueWatcher cmdlet adds one or more users as watchers of an ussue. You can specify the issue by key or ID. You can specify the user by name or account ID. Whether you use a user's account ID or name is dependent on the version of Jira that you are connecting to.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-JiraIssueWatcher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to watch.</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"> <maml:name>Watcher</maml:name> <maml:description> <maml:para>Specifies the names or account IDs of the users to add as watchers. Whether you use a user's account ID or name is dependent on the version of Jira that you are connecting 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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to watch.</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"> <maml:name>Watcher</maml:name> <maml:description> <maml:para>Specifies the names or account IDs of the users to add as watchers. Whether you use a user's account ID or name is dependent on the version of Jira that you are connecting 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet returns a string that contains the account ID or name of the user that was added as a watcher of the issue.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add active project users as watchers of an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $users = Get-JiraUser -Connection $connection -ProjectName 'Arcturus' PC C:\> Add-JiraIssueWatcher -Connection $connection -IssueKey 'JiraKey-15' -Watchers $users.AccountId</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Add-JiraIssueWorklog</command:name> <maml:description> <maml:para>Add a worklog to an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>JiraIssueWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-JiraIssueWorklog cmdlet adds a worklog to an issue. You can specify the issue by key or ID. By default this cmdlet will reduce the issue's remaining time estimate by the time spent in the worklog. This cmdlet will fail if time tracking is not enabled in Jira.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Auto" default="true"> <!--NAME: Auto--> <!--TAG: DEFAULT--> <maml:name>Add-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the worlog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that the worklog effort was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> <command:syntaxItem parametersetname="Leave"> <!--NAME: Leave--> <maml:name>Add-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the worlog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that the worklog effort was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeaveEstimate</maml:name> <maml:description> <maml:para>Indicates that the original time estimate should be left unchanged.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> <command:syntaxItem parametersetname="New"> <!--NAME: New--> <maml:name>Add-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the worlog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that the worklog effort was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewEstimate</maml:name> <maml:description> <maml:para>Specifies the issue's remaining time estimate.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> <command:syntaxItem parametersetname="Manual"> <!--NAME: Manual--> <maml:name>Add-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the worlog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that the worklog effort was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReduceEstimate</maml:name> <maml:description> <maml:para>Specifies the amount by which to reduce the issue's remaining time estimate.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to add the worlog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that the worklog effort was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>LeaveEstimate</maml:name> <maml:description> <maml:para>Indicates that the original time estimate should be left unchanged.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NewEstimate</maml:name> <maml:description> <maml:para>Specifies the issue's remaining time estimate.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ReduceEstimate</maml:name> <maml:description> <maml:para>Specifies the amount by which to reduce the issue's remaining time estimate.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, in which case the value will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns the ID of the worklog that was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a worklog, that started two hours ago, with a new time remaining estimate.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $started = (Get-Date).AddHours(-2) PS C:\> $timeSpent = New-TimeSpan -Hours 2 PS C:\> $estimate = New-TimeSpan -Hours 6 PS C:\> Add-JiraIssueWorklog -Connection $connection -IssueKey 'JiraKEY-15' -Started $started -TimeSpent $timeSpent -NewEstimate $estimate</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Add a worklog and automatically reduce the issue's remaining time estimate.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $started = (Get-Date).AddHours(-2) PS C:\> $timeSpent = New-TimeSpan -Hours 2 PS C:\> Add-JiraIssueWorklog -Connection $connection -IssueKey 'JiraKEY-15' -Started $started -TimeSpent $timeSpent</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssue</command:name> <maml:description> <maml:para>Gets issue details.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssue cmdlet retrieves issue details. You can identify which issues to retrieve by key or ID, by Jira Query Language (JQL) query or by Runbook Studio filter objects.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number of records to to skip over.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of issues to retrieve.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates that the issues should be returned in ascending order relative to the date and time the issue was created. The default is descending 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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="IssueKey"> <!--NAME: IssueKey--> <maml:name>Get-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the keys or IDs of the issues 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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Filters"> <!--NAME: Filters--> <maml:name>Get-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number of records to to skip over.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of issues to retrieve.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filter objects that will determine which issues to retrieve.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates that the issues should be returned in ascending order relative to the date and time the issue was created. The default is descending 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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Query"> <!--NAME: Query--> <maml:name>Get-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number of records to to skip over.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of issues to retrieve.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies a JQL query that will determine which issues 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates that the issues should be returned in ascending order relative to the date and time the issue was created. The default is descending 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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number of records to to skip over.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of issues to retrieve.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates that the issues should be returned in ascending order relative to the date and time the issue was created. The default is descending 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the keys or IDs of the issues 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filter objects that will determine which issues to retrieve.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies a JQL query that will determine which issues 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</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>This cmdlet returns objects that represent the issues that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Filters</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> <maml:alert> <maml:para>The Filters parameter specfies, as an array of filter objects, the issues to retrieve from Jira. Filter objects must have the following properties:</maml:para> <maml:para>Id: id of the field that is being filtered. Operator: the filter operator (EqualTo, NotEqualTo, Contains, DoesNotContain, LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo) Vlaue: the value to which the field is compared.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Use filters to get all escalated issues that were created today.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $today = Get-Date.Date PS C:\> $createFilter = [PSCustomObject]@{Id = 'created'; Operator = 'EqualTo'; Value = $today} PS C:\> $statusFilter = [PSCustomObject]@{Id = 'status'; Operator = 'EqualTo'; Value = 'Escalated'} PS C:\> $issues = Get-JiraIssue -Connection $connection -Filters @($createFilter, $statusFilter)</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Use JQL to get all issues that are unassigned and have not been updated in the last day.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $query = 'assignee is EMPTY and created < -1d' PS C:\> $issues = Get-JiraIssue -Connection $connection -Query $query</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Use the IssueKey parameter to get a specific issue</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $issue = Get-JiraIssue -Connection $connection -IssueKey 'JiraKEY-15'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Get the last 25 issues that were created.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $issues = Get-JiraIssue -Connection $connection -Limit 25</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssueAttachment</command:name> <maml:description> <maml:para>Gets the attachments that have been added to an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssueAttachment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssueAttachment cmdlet gets objects that represent the attachments that have been added to an issue. Note that this cmdlet does not retrieve the content of the attachments, for that you need to use the Get-JiraIssueAttachmentContent cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraIssueAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which attachments are to be retrieved.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which attachments are to be retrieved.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Atlassian.Jira.Output.AttachmentInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns objects that represent the attachments that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Gets all of the attachments for an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $attachments = Get-JiraIssueAttachment -Connection $connection -IssueKey 'JiraKey-15'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssueAttachmentContent</command:name> <maml:description> <maml:para>Downloads the content of an attachment as a byte array.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssueAttachmentContent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssueAttachment cmdlet downloads the content of a specified attachment as a byte array.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraIssueAttachmentContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AttachmentId</maml:name> <maml:description> <maml:para>Specifies the ID of the attachment to download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AttachmentId</maml:name> <maml:description> <maml:para>Specifies the ID of the attachment to download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an attachment ID to the AttachmentId parameter. You can also send an object with an AttachmentId parameter, in which case the value will be sent to the AttachmentId parameter.</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>This cmdlet returns the downloaded content as a byte array.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Download the content of an attachment and save it to a file</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $attachment = Get-JiraIssueAttachment -Connection $connection -IssueKey 'JiraKEY-15' | Where-Object FileName -EQ 'Error.png' PS C:\> $content = Get-JiraIssueAttachmentContent -Connection $connection -AttachmentId $attachment.AttachmentId PS C:\> Set-Content -Path '.\error.png' -Value $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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssueComment</command:name> <maml:description> <maml:para>Gets comments for an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssueComment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssueComment retrieves all of the comments for an issue. You can specify the issue by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraIssueComment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve comment objects.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve comment objects.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send the issue key or ID to the IssueyKey parameter. You can also send an object with an IssueKey property, in which case its value will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Atlassian.Jira.Output.CommentInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet return objects that represent issue comments.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get all the comments for an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $comments = Get-JiraIssueComment -Connection $connection -IssueKey 'JiraKEY-15'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssueTransition</command:name> <maml:description> <maml:para>Gets the transitions that can be performed by the user on an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssueTransition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssueTransition cmdlet retrieves the transitions that can be performed by the connected user on an issue, based on the issue's status. You can specify the issue by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraIssueTransition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve transitions.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve transitions.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Atlassian.Jira.Output.TransitionInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns objects that represents issue transitions.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get all the transitions for an issue where the name of the transition starts with 'Escalate',</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $transitions = Get-JiraIssueTransition -Connection $connection -IssueKey 'JiraKEY-15' | Where-Object TransitionName -Like 'Escalate*' PS C:\> Write-Output $transitions.TransitionName</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssueWatcher</command:name> <maml:description> <maml:para>Gets the users that are watchers of an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssueWatcher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssueWatcher cmdlet retrieves the users that are watchers of an issue. You can specify the issue by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraIssueWatcher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve watchers.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve watchers.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, in which case the value will also be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Atlassian.Jira.Output.WatcherInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns objects that represent issue watchers.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Write the display names of all the users that are watching an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $watchers = Get-JiraIssueWatcher -Connection $connection -IssueKey 'JiraKEY-15' PS C:\> Write-Output $watchers.DisplayName</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraIssueWorklog</command:name> <maml:description> <maml:para>Gets worklogs for an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraIssueWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraIssueWorklog cmdlet retrieves worklogs for an isssue. You can specify the issue by key or ID. This cmdlet will fail if time tracking is not enabled in Jira.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve worklogs.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue from which to retrieve worklogs.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, in which case the value will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Atlassian.Jira.Output.WorklogInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns objects that represent issue worklogs.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Write the names of the authors that have added worklogs to an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $worklogs = Get-JiraIssueWorklogs -Connection $connection -IssueKey 'JiraKEY-15' PS C:\> Write-Output $worklogs.Author.DisplayName</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-JiraUser</command:name> <maml:description> <maml:para>Gets the active and inactive users for a project.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>JiraUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-JiraUser cmdlet retrieves the active and inactive users for a specified project.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-JiraUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the name of the project to retrieve users 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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the name of the project to retrieve users 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send a string containing the name of a project to the Project parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.IntegrationModule.Atlassian.Jira.Output.UserInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns objects that represent the users that have been assigned to a project.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Write the names of all the users that have been assigned to a project.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $users = Get-JiraUser -Connection $connection -ProjectName 'Arcturus' PS C:\> Write-Output $users.DisplayName</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Invoke-JiraIssueTransition</command:name> <maml:description> <maml:para>Performs an issue transition.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>JiraIssueTransition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-JiraIssueTransition cmdlet performs an issue transition. You can specify the issue by key or ID and the transition by name or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="By Transition Id"> <!--NAME: By Transition Id--> <maml:name>Invoke-JiraIssueTransition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to transition.</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="True (ByPropertyName)" position="named"> <maml:name>TransitionId</maml:name> <maml:description> <maml:para>Specifies the ID of the transition to perform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the role or group to which the transition is visible.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specfies additional values, as a hashtable, that are required to perform the transition.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="By Transition Name"> <!--NAME: By Transition Name--> <maml:name>Invoke-JiraIssueTransition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to transition.</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"> <maml:name>TransitionName</maml:name> <maml:description> <maml:para>Specifies the name of the transition to perform.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the role or group to which the transition is visible.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specfies additional values, as a hashtable, that are required to perform the transition.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to transition.</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="True (ByPropertyName)" position="named"> <maml:name>TransitionId</maml:name> <maml:description> <maml:para>Specifies the ID of the transition to perform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment.</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="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the role or group to which the transition is visible.</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="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specfies additional values, as a hashtable, that are required to perform the transition.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TransitionName</maml:name> <maml:description> <maml:para>Specifies the name of the transition to perform.</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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey and TransitionId properties, in which case values will be sent to the IssueKey and TransitionId parameters, respectively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When invoked by transition ID, this cmdlet returns the ID of the transition that was performed.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When invokved by transition name, this cmdlet returns the name of the transition that was performed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Perform a transition that escalates an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $assignee = Get-JiraUser -Connection $connection -ProjectName 'Arcturus' | Where-Object EmailAddress -EQ 'hank.scorpio@globex.com' PS C:\> $values = @{assignee = $assignee.AccountId} PS C:\> Invoke-JiraIssueTransition -Connection $connection -IssueKey 'JiraKEY-15' -TransitionName 'Escalate' -Values $values</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-JiraIssue</command:name> <maml:description> <maml:para>Addes a new Jira issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>JiraIssue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-JiraIssue cmdlet adds a new Jira issue, or where permitted, a subtask. A transition may be invoked to move the issue or subtask to a workflow step.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the name of the project to create the issue or subtask 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IssueType</maml:name> <maml:description> <maml:para>Specifies the type of issue to add.</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"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies, as a hashtable, values to assign to the fields of the issue.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the name of the project to create the issue or subtask 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IssueType</maml:name> <maml:description> <maml:para>Specifies the type of issue to add.</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"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies, as a hashtable, values to assign to the fields of the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>You can't pipeline input to this cmdlet.</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs a string containing the issue key.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a new, high priority, issue</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $values = @{priority = 'High', summary = 'Out of coffee in third floor kitchen'} PS C:> New-JiraIssue -Connection $connection -ProjectName 'Arcturus' -IssueType 'Service Request' -Values $values</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-JiraIssue</command:name> <maml:description> <maml:para>Removes one or more issues.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>JiraIssue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-JiraIssue cmdlet removes one or more issues. You can specify the issues to remove by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the keys or IDs of the issues 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveSubtasks</maml:name> <maml:description> <maml:para>Indicates whether subtasks should also be 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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the keys or IDs of the issues 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RemoveSubtasks</maml:name> <maml:description> <maml:para>Indicates whether subtasks should also be 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send strings containg issuey keys or IDs to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns the keys or IDs of the issues that were removed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Remove a specific issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> Remove-JiraIssue -Connection $connection -IssueKey 'JiraKEY-15'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-JiraIssueAttachment</command:name> <maml:description> <maml:para>Removes ones or more attachments from an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>JiraIssueAttachment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-JiraIssueAttachment cmdlet removes one or more attachments from an issue.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-JiraIssueAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AttachmentId</maml:name> <maml:description> <maml:para>Specifies the IDs of the attachments to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AttachmentId</maml:name> <maml:description> <maml:para>Specifies the IDs of the attachments to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an attachment ID to the AttachmentId parameter. You can also send an object with IssueKey and AttachmentId properties, in which case values will be sent to the IssueKey and AttachmentId parameters, respectively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the IDs of the attachments that were removed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Remove all of the attachments from an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $attachments = Get-JiraIssueAttachment -Connection $connection -IssueKey 'JiraKEY-15' PC C:\> $acttachments | Remove-JiraIssueAttachment -Connection $connection</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-JiraIssueComment</command:name> <maml:description> <maml:para>Removes one or more comments from an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>JiraIssueComment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-JiraIssueComment cmdlet removes one or more comments from an issue. You can specify the issue by key or ID. The IDs of the comments to be removed are specified as an Int64 array.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-JiraIssueComment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the comments 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>CommentId</maml:name> <maml:description> <maml:para>Specifies the IDs of the comments to be removed from the issue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the comments 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>CommentId</maml:name> <maml:description> <maml:para>Specifies the IDs of the comments to be removed from the issue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send a comment ID to the CommentId parameter. You can also use the pipeline to send an object with IssueKey and CommentId properties, in which case values will be sent to the IssueyKey and CommentId parameters, respectively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the IDs of the comments that were removed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Remove all of the comments from an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $comments = Get-JiraIssueComment -Connection $connection -IssueKey 'JiraKEY-12' PS C:\> $comments | Remove-JiraIssueComment -Connection $connection</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-JiraIssueWatcher</command:name> <maml:description> <maml:para>Removes one or more users as watchers of an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>JiraIssueWatcher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-JiraIssueWatcher cmdlet removes users as watchers of an issue. You can specify the issue by key or ID. You can specify the user by account ID or name. Whether you identify the watchers by account ID or name, is dependent on the Jira instance you are connecting to.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-JiraIssueWatcher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to stop watching.</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"> <maml:name>Watcher</maml:name> <maml:description> <maml:para>Specifies the account IDs or names of the users to remove as a watchers.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to stop watching.</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"> <maml:name>Watcher</maml:name> <maml:description> <maml:para>Specifies the account IDs or names of the users to remove as a watchers.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an account ID or name to the Watcher parameter. You can also send an object with IssueKey or AccountId properties, in which case the values will be sent to the IssueKey and Watcher parameters, respectively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns strings that contain the account IDs or names of the users that were removed as watchers.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Remove all users as watchers, except for the user that created the issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $issue = Get-JiraIssue -Connection $connection -IssueKey 'JiraKEY-123' PS C:\> $users = Get-JiraUser -Connection $connection -ProjectName 'Arcturus' | Where-Object AccoundId -NE $issue.Creator PS C:\> $users | Remove-JiraIssueUser -Connection $connection -IssueKey JiraKEY-123'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-JiraIssueWorklog</command:name> <maml:description> <maml:para>Removes one or more worklogs from an issue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>JiraIssueWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-JiraIssueWorklog cmdlet removes one or more worklogs from an issue. You can specify the issue by key or ID. By default this cmdlet will automatically increase the issue's remaining time estimate by the time spent in the worklog. This cmdlet will fail if time tracking is not enabled in Jira.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Auto" default="true"> <!--NAME: Auto--> <!--TAG: DEFAULT--> <maml:name>Remove-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the worklog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Leave"> <!--NAME: Leave--> <maml:name>Remove-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the worklog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeaveEstimate</maml:name> <maml:description> <maml:para>Indicates that the original time estimate should be left unchanged.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="New"> <!--NAME: New--> <maml:name>Remove-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the worklog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewEstimate</maml:name> <maml:description> <maml:para>Specifies the issue's new remaining time estimate.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Manual"> <!--NAME: Manual--> <maml:name>Remove-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the worklog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncreaseEstimate</maml:name> <maml:description> <maml:para>Specifies the amount by which to increase the issue's remaining time estimate.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue to remove the worklog 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>LeaveEstimate</maml:name> <maml:description> <maml:para>Indicates that the original time estimate should be left unchanged.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NewEstimate</maml:name> <maml:description> <maml:para>Specifies the issue's new remaining time estimate.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IncreaseEstimate</maml:name> <maml:description> <maml:para>Specifies the amount by which to increase the issue's remaining time estimate.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send a worklog ID to the WorklogId parameter. You can also send an object with IssueKey and WorklogId properties, in which case values will be sent to the IssueKey and WorklogId parameters, respectively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the IDs of the worklogd that were removed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Remove all worklogs from an issue and automatically update the issue's estimated time remaining.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $worklogs = Get-JiraIssueWorklog -Connection $connection -IssueKey 'JiraKEY-123' PS C:\> $worklogs | Remove-JiraIssueWorklog -Connection $connection</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-JiraIssue</command:name> <maml:description> <maml:para>Updates one or more issues.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>JiraIssue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-JiraIssue cmdlet updates one or more issues. You can specify the issues to update by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-JiraIssue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the keys or IDs of the issues 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"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the field values, as a hashtable, to assign to each issue.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the keys or IDs of the issues 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"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the field values, as a hashtable, to assign to each issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send an issue key or ID to the IssueKey parameter. You can also send an object with an IssueKey property, the value of which will be sent to the IssueKey parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns the key or ID of the issues that were updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Update the due date of an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $dueDate = (Get-Date).AddDays(3) PS C:\> $values = @{duedate = $dueDate} PS C:\> Set-JiraIssue -Connection $connection -IssueKey 'JiraKEY-123' -Values $values</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-JiraIssueComment</command:name> <maml:description> <maml:para>Updates an issue comment.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>JiraIssueComment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-JiraIssueComment cmdlet updates an issue comment. You can specify the issue by key or ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-JiraIssueComment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Sepcifies the key or ID of the issue that contains the comment.</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="True (ByPropertyName)" position="named"> <maml:name>CommentId</maml:name> <maml:description> <maml:para>Specifies the ID of the comment to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies the comment 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the comment is visible.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Sepcifies the key or ID of the issue that contains the comment.</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="True (ByPropertyName)" position="named"> <maml:name>CommentId</maml:name> <maml:description> <maml:para>Specifies the ID of the comment to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies the comment 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the comment is visible.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send a comment ID to the CommentId parameter. You can also use the pipeline to send an object that cotains IssueyKey and CommentId properties, in which case values will be sent to the IssueKey and CommentId parameters, respetively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns the ID of the comment that was updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key and information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Change the visibility of the comments for an issue.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $comments = Get-JiraIssueComment -Connection $connection -IssueKey 'JiraKEY-123' PS C:\> $comments | Set-JiraIssueComment -Connection $connection -Visibility 'Service Desk Team'</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-JiraIssueWorklog</command:name> <maml:description> <maml:para>Updates an issue worklog.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>JiraIssueWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-JiraIssueWorklog cmdlet updates an issue worklog. You can specify the issue by key or ID. By default this cmdlet updates the issue's remaining time estimate by the difference betwen the original and updated times spent in the worklog. This cmdlet will fail if time tracking is not enabled in Jira.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Auto" default="true"> <!--NAME: Auto--> <!--TAG: DEFAULT--> <maml:name>Set-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue that the worklog is 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the ID of the worklog to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that work was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> <command:syntaxItem parametersetname="Leave"> <!--NAME: Leave--> <maml:name>Set-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue that the worklog is 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the ID of the worklog to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that work was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeaveEstimate</maml:name> <maml:description> <maml:para>Indicates that the original time estimate should be left unchanged.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> <command:syntaxItem parametersetname="New"> <!--NAME: New--> <maml:name>Set-JiraIssueWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue that the worklog is 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the ID of the worklog to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that work was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewEstimate</maml:name> <maml:description> <maml:para>Specifies the issue's new remaining time estimate.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>IssueKey</maml:name> <maml:description> <maml:para>Specifies the key or ID of the issue that the worklog is 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>WorkLogId</maml:name> <maml:description> <maml:para>Specifies the ID of the worklog to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>Specifies the time spent working on the issue.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Started</maml:name> <maml:description> <maml:para>Specifies the date and time that work was started.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment about the worklog effort.</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="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the group or role to which the worklog is visible.</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="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies, in a hashtable, information used to connect to Jira.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>LeaveEstimate</maml:name> <maml:description> <maml:para>Indicates that the original time estimate should be left unchanged.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NewEstimate</maml:name> <maml:description> <maml:para>Specifies the issue's new remaining time estimate.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the pipeline to send a worklog ID to the WorklogId parameter. You can also send objects with IssueKey and WorklogId properties, in which case values will be sent to the IssueKey and WorklogId parameters, respectively.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet returns the IDs of the worklogs that were updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Connection Parameter</maml:title> <maml:alert> <maml:para>The connection parameter specifies, in a hashtable, your license key as well as information used to connect to Jira. The hashtable must include the following information:</maml:para> <maml:para>JiraWebServiceUrl: the URI of the Jira web service endpoint. UserName: the name or email address of a user with permissions to access Jira. Password: the password of the Jira user. LicenseKey: the license key that entitles you to use the module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Update the time that was spent on a worklog and automatically adjust the issue's estimated time remaining.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $worklog = Get-JiraIssueWorklog -Connection $connection -IssueKey 'JiraKEY-123' PS C;\> $timeSpent = New-TimeSpan -Hours 1 PS C:\> $worklog | Set-JiraIssueWorklog -Connection $connection -TimeSpent $timeSpent </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Update the time spent on a worklog but leave the original estimate unchanged.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Jira' PS C:\> $worklog = Get-JiraIssueWorklog -Connection $connection -IssueKey 'JiraKEY-123' PS C;\> $timeSpent = New-TimeSpan -Minutes 30 PS C:\> $worklog | Set-JiraIssueWorklog -Connection $connection -TimeSpent $timeSpent -LeaveEstimate </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> </helpItems> |