< Back
Format-Jira
Post
NAME Format-Jira
SYNOPSIS
Converts an object into a table formatted according to JIRA's markdown syntax
SYNTAX
Format-Jira [-InputObject] <PSObject[]> [[-Property] <Object[]>] [<CommonParameters>]
DESCRIPTION
This function converts a PowerShell object into a table using JIRA's markdown syntax. This can then be added to a
JIRA issue description or comment.
PARAMETERS
-InputObject <PSObject[]>
Object to format.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Property <Object[]>
List of properties to display. If omitted, only the default properties will be shown.
To display all properties, use `-Property *`.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
[System.Object[]]
accepts any Object via pipeline
OUTPUTS
[System.String]
NOTES
Like the native `Format-*` cmdlets, this is a destructive operation.
Remember to "filter left, format right!"
-------------------------- EXAMPLE 1 --------------------------
Get-Process | Format-Jira | Add-JiraIssueComment -Issue TEST-001
This example illustrates converting the output from `Get-Process` into a JIRA table, which is then added as a
comment to issue TEST-001.
-------------------------- EXAMPLE 2 --------------------------
Get-Process chrome | Format-Jira Name,Id,VM
This example obtains all Google Chrome processes, then creates a JIRA table with only the Name,ID, and VM
properties of each object.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... rmat-Jira/
SYNOPSIS
Converts an object into a table formatted according to JIRA's markdown syntax
SYNTAX
Format-Jira [-InputObject] <PSObject[]> [[-Property] <Object[]>] [<CommonParameters>]
DESCRIPTION
This function converts a PowerShell object into a table using JIRA's markdown syntax. This can then be added to a
JIRA issue description or comment.
PARAMETERS
-InputObject <PSObject[]>
Object to format.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Property <Object[]>
List of properties to display. If omitted, only the default properties will be shown.
To display all properties, use `-Property *`.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
[System.Object[]]
accepts any Object via pipeline
OUTPUTS
[System.String]
NOTES
Like the native `Format-*` cmdlets, this is a destructive operation.
Remember to "filter left, format right!"
-------------------------- EXAMPLE 1 --------------------------
Get-Process | Format-Jira | Add-JiraIssueComment -Issue TEST-001
This example illustrates converting the output from `Get-Process` into a JIRA table, which is then added as a
comment to issue TEST-001.
-------------------------- EXAMPLE 2 --------------------------
Get-Process chrome | Format-Jira Name,Id,VM
This example obtains all Google Chrome processes, then creates a JIRA table with only the Name,ID, and VM
properties of each object.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... rmat-Jira/