Cake.AzureDevOps

Addin for the Cake build automation system for working with Azure DevOps or Azure DevOps Server. 

#addin nuget:?package=Cake.AzureDevOps&version=5.0.0

dotnet add package Cake.AzureDevOps --version 5.0.0

<PackageReference Include="Cake.AzureDevOps" Version="5.0.0" />

Aliases

Contains functionality related to Azure DevOps.

Authentication

AzureDevOpsAuthenticationAzureActiveDirectory(string, string) Returns credentials for authentication with an Azure Active Directory. Can only be used with Azure DevOps.
AzureDevOpsAuthenticationBasic(string, string) Returns credentials for basic authentication. Can only be used for on-premise Azure DevOps Server configured for basic authentication. See https://www.visualstudio.com/en-us/docs/integrate/get-started/auth/tfs-basic-auth.
AzureDevOpsAuthenticationNtlm() Returns credentials for integrated / NTLM authentication. Can only be used for on-premise Azure DevOps Server.
AzureDevOpsAuthenticationOAuth(string) Returns credentials for OAuth authentication. Can only be used with Azure DevOps.
AzureDevOpsAuthenticationPersonalAccessToken(string) Returns credentials for authentication with a personal access token. Can be used for Azure DevOps Server and Azure DevOps Service.

Azure Boards

AzureDevOpsWorkItem(AzureDevOpsWorkItemSettings) Gets an Azure DevOps work item using the specified settings.
AzureDevOpsWorkItemUsingAzurePipelinesOAuthToken(int, bool) Gets the description of a specific work item the access token provided by Azure Pipelines. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsWorkItemUsingAzurePipelinesOAuthToken(int) Gets the description of a specific work item the access token provided by Azure Pipelines. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.

Azure Pipelines

AzureDevOpsBuild(AzureDevOpsBuildSettings) Gets an Azure Pipelines build using the specified settings.
AzureDevOpsBuildArtifacts(AzureDevOpsBuildSettings) Gets the build artifacts for an Azure Pipelines build.
AzureDevOpsBuildChanges(AzureDevOpsBuildSettings) Gets the changes associated with an Azure Pipelines build.
AzureDevOpsBuildDefinitions(AzureDevOpsBuildsSettings) Gets Azure Pipelines build definitions for the specified settings.
AzureDevOpsBuildIsFailing(AzureDevOpsBuildSettings) Returns if the Azure DevOps build is failing.
AzureDevOpsBuilds(AzureDevOpsBuildsSettings) Gets Azure Pipelines builds using the specified settings.
AzureDevOpsBuildTestRuns(AzureDevOpsBuildSettings) Gets the test runs for an Azure Pipelines build.
AzureDevOpsBuildTimelineRecords(AzureDevOpsBuildSettings) Gets the timeline entries for an Azure Pipelines build.
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(bool) Gets the description of the Azure Pipelines build which is running. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(int, bool) Gets the description of a specific build which is running the access token provided by Azure Pipelines. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(int) Gets the description of a specific build which is running the access token provided by Azure Pipelines. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsBuildUsingAzurePipelinesOAuthToken() Gets the description of the Azure Pipelines build which is running. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsBuildWorkItemIds(AzureDevOpsBuildSettings) Gets the work item ids associated with an Azure Pipelines build.
AzureDevOpsBuildWorkItems(AzureDevOpsBuildSettings) Gets the work items associated with an Azure Pipelines build.

Pull Request

AzureDevOpsAddCommentToPullRequest(AzureDevOpsPullRequestSettings, string) Adds a new comment thread with a single comment to an Azure DevOps pull request using the specified settings.
AzureDevOpsCreatePullRequest(AzureDevOpsCreatePullRequestSettings) Creates a pull request in Azure DevOps using the specified settings.
AzureDevOpsGetPullRequestCommits(AzureDevOpsPullRequestSettings) Gets the commits contained in the Azure DevOps pull request using the specified settings.
AzureDevOpsPullRequest(AzureDevOpsPullRequestSettings) Gets an Azure DevOps pull request using the specified settings.
AzureDevOpsPullRequestUsingAzurePipelinesOAuthToken(bool) Gets an Azure DevOps pull request using the settings provided by an Azure Pipelines build. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsPullRequestUsingAzurePipelinesOAuthToken() Gets an Azure DevOps pull request using the settings provided by an Azure Pipelines build. Make sure the build has the 'Allow Scripts to access OAuth token' option enabled.
AzureDevOpsSetPullRequestStatus(AzureDevOpsPullRequestSettings, AzureDevOpsPullRequestStatus) Sets a status on an Azure DevOps pull request using the specified settings.
AzureDevOpsVotePullRequest(AzureDevOpsPullRequestSettings, AzureDevOpsPullRequestVote) Votes for an Azure DevOps pull request using the specified settings.