AzureDevOpsAliases Class

Summary

Contains functionality related to Azure DevOps.
Assembly
Cake.AzureDevOps.dll
Namespace
Cake.AzureDevOps
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["AzureDevOpsAliases"] class Type type-node

Syntax

public static class AzureDevOpsAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
AzureDevOpsAddCommentToPullRequest(ICakeContext, AzureDevOpsPullRequestSettings, string) void
Adds a new comment thread with a single comment to an Azure DevOps pull request using the specified settings.
static
AzureDevOpsAuthenticationAzureActiveDirectory(ICakeContext, string, string) IAzureDevOpsCredentials
Returns credentials for authentication with an Azure Active Directory. Can only be used with Azure DevOps.
static
AzureDevOpsAuthenticationBasic(ICakeContext, string, string) IAzureDevOpsCredentials
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.
static
AzureDevOpsAuthenticationNtlm(ICakeContext) IAzureDevOpsCredentials
Returns credentials for integrated / NTLM authentication. Can only be used for on-premise Azure DevOps Server.
static
AzureDevOpsAuthenticationOAuth(ICakeContext, string) IAzureDevOpsCredentials
Returns credentials for OAuth authentication. Can only be used with Azure DevOps.
static
AzureDevOpsAuthenticationPersonalAccessToken(ICakeContext, string) IAzureDevOpsCredentials
Returns credentials for authentication with a personal access token. Can be used for Azure DevOps Server and Azure DevOps Service.
static
AzureDevOpsBuild(ICakeContext, AzureDevOpsBuildSettings) AzureDevOpsBuild
Gets an Azure Pipelines build using the specified settings.
static
AzureDevOpsBuildArtifacts(ICakeContext, AzureDevOpsBuildSettings) IEnumerable<AzureDevOpsBuildArtifact>
Gets the build artifacts for an Azure Pipelines build.
static
AzureDevOpsBuildChanges(ICakeContext, AzureDevOpsBuildSettings) IEnumerable<AzureDevOpsChange>
Gets the changes associated with an Azure Pipelines build.
static
AzureDevOpsBuildDefinitions(ICakeContext, AzureDevOpsBuildsSettings) IEnumerable<AzureDevOpsBuildDefinition>
Gets Azure Pipelines build definitions for the specified settings.
static
AzureDevOpsBuildIsFailing(ICakeContext, AzureDevOpsBuildSettings) bool
Returns if the Azure DevOps build is failing.
static
AzureDevOpsBuilds(ICakeContext, AzureDevOpsBuildsSettings) IEnumerable<AzureDevOpsBuild>
Gets Azure Pipelines builds using the specified settings.
static
AzureDevOpsBuildTestRuns(ICakeContext, AzureDevOpsBuildSettings) IEnumerable<AzureDevOpsTestRun>
Gets the test runs for an Azure Pipelines build.
static
AzureDevOpsBuildTimelineRecords(ICakeContext, AzureDevOpsBuildSettings) IEnumerable<AzureDevOpsTimelineRecord>
Gets the timeline entries for an Azure Pipelines build.
static
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(ICakeContext) AzureDevOpsBuild
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.
static
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(ICakeContext, bool) AzureDevOpsBuild
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.
static
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(ICakeContext, int) AzureDevOpsBuild
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.
static
AzureDevOpsBuildUsingAzurePipelinesOAuthToken(ICakeContext, int, bool) AzureDevOpsBuild
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.
static
AzureDevOpsCreatePullRequest(ICakeContext, AzureDevOpsCreatePullRequestSettings) AzureDevOpsPullRequest
Creates a pull request in Azure DevOps using the specified settings.
static
AzureDevOpsGetPullRequestCommits(ICakeContext, AzureDevOpsPullRequestSettings) IEnumerable<AzureDevOpsCommit>
Gets the commits contained in the Azure DevOps pull request using the specified settings.
static
AzureDevOpsPullRequest(ICakeContext, AzureDevOpsPullRequestSettings) AzureDevOpsPullRequest
Gets an Azure DevOps pull request using the specified settings.
static
AzureDevOpsPullRequestUsingAzurePipelinesOAuthToken(ICakeContext) AzureDevOpsPullRequest
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.
static
AzureDevOpsPullRequestUsingAzurePipelinesOAuthToken(ICakeContext, bool) AzureDevOpsPullRequest
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.
static
AzureDevOpsSetPullRequestStatus(ICakeContext, AzureDevOpsPullRequestSettings, AzureDevOpsPullRequestStatus) void
Sets a status on an Azure DevOps pull request using the specified settings.
static
AzureDevOpsVotePullRequest(ICakeContext, AzureDevOpsPullRequestSettings, AzureDevOpsPullRequestVote) void
Votes for an Azure DevOps pull request using the specified settings.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin