Functions/Get-BBServerRepository.ps1
|
# Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. function Get-BBServerRepository { <# .SYNOPSIS Gets Bitbucket Server repositories. .DESCRIPTION The `Get-BBServerRepository` function gets Bitbucket Server repositories. Only the repositories under a specific project are returned. Pass the project's key/ID whose repositories to get with the `ProjectKey` parameter. Use the `New-BBServerConnection` function to create a connection object that is passed to the `Connection` parameter. The returned objects have the following properties: * `slug`: The repository's public key/ID. Use this value when a Bitbucket Server Automation function has a `RepositorySlug` parameter. * `id`: Bitbucket Server's internal, numeric ID for the repository. * `name` * `scmId`: the repository's source code management system. Bitbucket Server only supports Git. * `state` * `statusMessage` * `forkable`: a flag that indicates if the repository supports forking * `project`: a project object for the repository's project * `public`: a flag indicating if the repository is public or not * `links`: an object with two properties: `clone` an array of URLs you can use to clone; and `self` an HTTP URL for viewing the repository in a web browser .EXAMPLE Get-BBServerRepository -Connection $conn -ProjectKey 'BBSA' Demonstrates how to get all the repositories under the `BBSA` project. #> [CmdletBinding()] param( [Parameter(Mandatory=$true)] [object] # The connection information that describe what Bitbucket Server instance to connect to, what credentials to use, etc. Use the `New-BBServerConnection` function to create a connection object. $Connection, [Parameter(Mandatory=$true)] [string] # The key/ID that identifies the project where the repository will be created. This is *not* the project name. $ProjectKey, [string] # The name of a specific repository to get. $Name ) Set-StrictMode -Version 'Latest' $resourcePath = 'projects/{0}/repos' -f $ProjectKey $result = Invoke-BBServerRestMethod -Connection $Connection -Method Get -ApiName 'api' -ResourcePath $resourcePath -IsPaged -ErrorVariable 'errors' if( $Name ) { $result | Where-Object { return $_.Name -like $Name } | Add-PSTypeName -RepositoryInfo } else { $result | Add-PSTypeName -RepositoryInfo } } |