AzureDevOpsBuildsSettings Class

Summary

Settings for aliases handling builds.
Assembly
Cake.AzureDevOps.dll
Namespace
Cake.AzureDevOps.Pipelines
Base Types
graph BT Type-->Base0["BaseAzureDevOpsProjectSettings"] click Base0 "/api/Cake.AzureDevOps/BaseAzureDevOpsProjectSettings" Base0-->Base1["BaseAzureDevOpsCollectionSettings"] click Base1 "/api/Cake.AzureDevOps/BaseAzureDevOpsCollectionSettings" Base1-->Base2["BaseAzureDevOpsCredentialsSettings"] click Base2 "/api/Cake.AzureDevOps/BaseAzureDevOpsCredentialsSettings" Base2-->Base3["Object"] Type["AzureDevOpsBuildsSettings"] class Type type-node

Syntax

public class AzureDevOpsBuildsSettings : BaseAzureDevOpsProjectSettings

Constructors

Name Summary
AzureDevOpsBuildsSettings(AzureDevOpsBuildsSettings) Initializes a new instance of the AzureDevOpsBuildsSettings class based on the instance of a AzureDevOpsBuildsSettings class.
AzureDevOpsBuildsSettings(IAzureDevOpsCredentials) Initializes a new instance of the AzureDevOpsBuildsSettings class using environment variables as set by an Azure Pipelines build.
AzureDevOpsBuildsSettings(Uri, Guid, IAzureDevOpsCredentials) Initializes a new instance of the AzureDevOpsBuildsSettings class.
AzureDevOpsBuildsSettings(Uri, string, IAzureDevOpsCredentials) Initializes a new instance of the AzureDevOpsBuildsSettings class.

Properties

Name Value Summary
CollectionUrl Uri
Gets the full URL of the Azure DevOps collection, eg. 
http://myserver:8080/defaultcollection
.
Credentials IAzureDevOpsCredentials
Gets the credentials used to authenticate against Azure DevOps.
ProjectGuid Guid
Gets the Guid of the project. Can be System.Guid.Empty if ProjectName is set.
ProjectName string
Gets the name of the project. Can be null if ProjectGuid is set.

Methods

Name Value Summary
get_BranchName() string
get_BuildDefinitionName() string
get_BuildQueryOrder() Nullable<AzureDevOpsBuildQueryOrder>
get_BuildResult() Nullable<AzureDevOpsBuildResult>
get_BuildStatus() Nullable<AzureDevOpsBuildStatus>
get_MaxBuildsPerDefinition() Nullable<int>
get_Top() Nullable<int>
set_BranchName()
set_BuildDefinitionName()
set_BuildQueryOrder()
set_BuildResult()
set_BuildStatus()
set_MaxBuildsPerDefinition()
set_Top()
UsingAzurePipelinesOAuthToken() AzureDevOpsBuildsSettings
Constructs the settings object using the access token provided by Azure Pipelines.
static

Extension Methods

Name Value Summary
Dump<AzureDevOpsBuildsSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AzureDevOpsBuildsSettings>(AzureDevOpsBuildsSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AzureDevOpsBuildsSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AzureDevOpsBuildsSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AzureDevOpsBuildsSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AzureDevOpsBuildsSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin