< Back
Get-JiraProject
Post
NAME Get-JiraProject
SYNOPSIS
Returns a project from Jira
SYNTAX
Get-JiraProject [-Project] <String[]> [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
This function returns information regarding a specified project from Jira.
If the Project parameter is not supplied, it will return information about all projects the given user is
authorized to view.
The `-Project` parameter will accept either a project ID or a project key.
PARAMETERS
-Project <String[]>
The Project ID or project key of a project to search.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? named
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
OUTPUTS
[JiraPS.Project]
NOTES
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
Remaining operations for `project` have not yet been implemented in the module.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraProject -Project TEST -Credential $cred
Returns information about the project TEST
-------------------------- EXAMPLE 2 --------------------------
Get-JiraProject 2 -Credential $cred
Returns information about the project with ID 2
-------------------------- EXAMPLE 3 --------------------------
Get-JiraProject
Returns information about all projects the user is authorized to view
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... raProject/
SYNOPSIS
Returns a project from Jira
SYNTAX
Get-JiraProject [-Project] <String[]> [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
This function returns information regarding a specified project from Jira.
If the Project parameter is not supplied, it will return information about all projects the given user is
authorized to view.
The `-Project` parameter will accept either a project ID or a project key.
PARAMETERS
-Project <String[]>
The Project ID or project key of a project to search.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? named
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
OUTPUTS
[JiraPS.Project]
NOTES
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
Remaining operations for `project` have not yet been implemented in the module.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraProject -Project TEST -Credential $cred
Returns information about the project TEST
-------------------------- EXAMPLE 2 --------------------------
Get-JiraProject 2 -Credential $cred
Returns information about the project with ID 2
-------------------------- EXAMPLE 3 --------------------------
Get-JiraProject
Returns information about all projects the user is authorized to view
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... raProject/