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

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.

Teams

The module will automatically select your team if you have 1 when logging in or prompt you to choose from a list of teams. Cmdlets will default to the team selected unless specified. If you wish to change the team run Select-BitbucketTeam. 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-BitbucketSelectedTeam
• Get-BitbucketTeam
• New-BitbucketLogin
• Remove-BitbucketLogin
• Save-BitbucketLogin
• Select-BitbucketTeam

Pipeline CMDLETs

• Start-BitbucketPipeline
• Wait-BitbucketPipeline

Project CMDLETs

• Get-BitbucketProject

Pull Request CMDLETs

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

Repository CMDLETs

• Add-BitbucketRepositoryReviewer
• Get-BitbucketRepository
• Get-BitbucketRepositoryEnvironment
• Get-BitbucketRepositoryDeployment
• Get-BitbucketRepositoryReviewer
• New-BitbucketRepository
• New-BitbucketRepositoryEnvironment
• Remove-BitbucketRepository
• Remove-BitbucketRepositoryEnvironment
• Remove-BitbucketRepositoryReviewer
• Set-BitbucketRepository
• Set-BitbucketRepositoryReviewer

Experimental Internal CMDLETs

The following CMDLETs are provided but use internal Bitbucket APIs. These CMDLETs would not be possible without accessing the internal APIs, but are much more likely to break if Atlassian changes their internal API. To use these CMDLETs you must also use OAuth 2.0 when logging in.

• Get-BitbucketRepositoryEnvironmentVariable
• New-BitbucketRepositoryEnvironmentVariable
• Remove-BitbucketRepositoryEnvironmentVariable

Changes

See CHANGELOG for more information.

Contributing

See CONTRIBUTING for more information.

License

See LICENSE for more information.