Atlassian.Bitbucket

See PowerShell Gallery for more information.

Build Status

Windows	Linux	macOS

Using The Module

Installation

Run the following command in an elevated PowerShell session to install the module from the PowerShell Gallery.

Install-Module Atlassian.Bitbucket

Update

If you already have the module installed, run the following command in an elevated PowerShell session to update the module from the PowerShell Gallery to the latest version.

Update-Module Atlassian.Bitbucket

Authentication

The module provides session level authentication with optional machine / user encrypted persistance between sessions.

Authentication Methods

The module supports both Basic authentication and OAuth 2.0 for the Bitbucket API's.

How To Login

Basic Auth

For basic auth I recommend you use App Passwords along with your username. When generating the App Password make sure to include read access to the account and workspace membership for login validation.

Login-Bitbucket

OAuth 2.0

For OAuth 2.0 Login you will need two sets of credentials.

1. Your Atlassian credentials: email and password
2. Key and Secret for OAuth Consumer.

$Cred = Get-Credential -UserName '<Email>'
$OAuth = Get-Credential -UserName '<OAuth Consumer Key>'

Login-Bitbucket -AtlassianCredential $Cred -OAuthConsumer $OAuth

Persistence

Use Login-Bitbucket -Save when logging in or Save-BitbucketLogin at any time to save the information to an encrypted file that will be automatically loaded when you start a new session.

Workspaces

The module will automatically select your workspace if you have 1 when logging in or prompt you to choose from a list of workspaces. Cmdlets will default to the workspace selected unless specified. If you wish to change the workspace run Select-BitbucketWorkspace. If you want to save the change run Save-BitbucketLogin again.

CMDLETs

To get more information on each cmdlet run Get-Help <CMDLET Name>

Authentication CMDLETs

• Get-BitbucketLogin
• Get-BitbucketSelectedWorkspace
• Get-BitbucketWorkspace
• New-BitbucketLogin
• Remove-BitbucketLogin
• Save-BitbucketLogin
• Select-BitbucketWorkspace

Pipeline CMDLETs

• Enable-BitbucketPipelineConfig
• Get-BitbucketPipeline
• Get-BitbucketPipelineConfig
• Get-BitbucketPipelineStep
• Start-BitbucketPipeline
• Wait-BitbucketPipeline

Project CMDLETs

• Get-BitbucketProject

Pull Request CMDLETs

• Get-BitbucketPullRequest
• Get-BitbucketPullRequestComment
• New-BitbucketPullRequest
• New-BitbucketPullRequestComment

Repository CMDLETs

• Add-BitbucketRepositoryBranch
• Get-BitbucketRepository
• Get-BitbucketRepositoryBranch
• Get-BitbucketRepositoryBranchModel
• New-BitbucketRepository
• Remove-BitbucketRepository
• Set-BitbucketRepository
• Set-BitbucketRepositoryBranchModel

Deployment CMDLETs

• Get-BitbucketRepositoryDeployment

Environment CMDLETs

• Get-BitbucketRepositoryEnvironment
• New-BitbucketRepositoryEnvironment
• Remove-BitbucketRepositoryEnvironment

Permission CMDLETs

• Add-BitbucketRepositoryGroupPermission
• Get-BitbucketRepositoryGroupPermission
• New-BitbucketRepositoryGroupPermission
• Remove-BitbucketRepositoryGroupPermission
• Set-BitbucketRepositoryGroupPermission

Restriction CMDLETs

• Add-BitbucketRepositoryBranchRestriction
• Get-BitbucketRepositoryBranchRestriction
• New-BitbucketRepositoryBranchRestrictionMergeCheck
• New-BitbucketRepositoryBranchRestrictionPermissionCheck
• Remove-BitbucketRepositoryBranchRestriction
• Set-BitbucketRepositoryBranchRestriction

Reviewer CMDLETs

• Add-BitbucketRepositoryReviewer
• Get-BitbucketRepositoryReviewer
• Remove-BitbucketRepositoryReviewer
• Set-BitbucketRepositoryReviewer

Variable CMDLETs

• Get-BitbucketRepositoryVariable
• New-BitbucketRepositoryVariable
• Remove-BitbucketRepsitoryVariable

User CMDLETs

• Add-BitbucketUserToGroup
• Get-BitbucketGroup
• Get-BitbucketUser
• Get-BitbucketUsersByGroup

Reports

• Get-BitbucketProjectDeploymentReport

HTML Formatted Report Example

• The screenshot doesn't show the repo names or expanded cards. When expanded the cards show the pipeline #, last commit and date and are clickable to take you directly to the pipeline run in Bitbucket.

Changes

See CHANGELOG for more information.

Contributing

See CONTRIBUTING for more information.

License

See LICENSE for more information.