BaseAzureDevOpsProjectSettings Class

Summary

Base settings for aliases scoped to project level.
graph BT Type-->Base0["BaseAzureDevOpsCollectionSettings"] click Base0 "/api/Cake.AzureDevOps/BaseAzureDevOpsCollectionSettings" Base0-->Base1["BaseAzureDevOpsCredentialsSettings"] click Base1 "/api/Cake.AzureDevOps/BaseAzureDevOpsCredentialsSettings" Base1-->Base2["Object"] Type["BaseAzureDevOpsProjectSettings"] class Type type-node Derived0["AzureDevOpsBuildSettings"]-->Type click Derived0 "/api/Cake.AzureDevOps.Pipelines/AzureDevOpsBuildSettings" Derived1["AzureDevOpsWorkItemSettings"]-->Type click Derived1 "/api/Cake.AzureDevOps.Boards.WorkItemTracking/AzureDevOpsWorkItemSettings" Derived2["AzureDevOpsBuildsSettings"]-->Type click Derived2 "/api/Cake.AzureDevOps.Pipelines/AzureDevOpsBuildsSettings"

Syntax

public abstract class BaseAzureDevOpsProjectSettings : BaseAzureDevOpsCollectionSettings

Constructors

Name Summary
BaseAzureDevOpsProjectSettings(BaseAzureDevOpsProjectSettings) Initializes a new instance of the BaseAzureDevOpsProjectSettings class based on the instance of a BaseAzureDevOpsProjectSettings class.
BaseAzureDevOpsProjectSettings(IAzureDevOpsCredentials) Initializes a new instance of the BaseAzureDevOpsProjectSettings class using environment variables as set by an Azure Pipelines build.
BaseAzureDevOpsProjectSettings(Uri, Guid, IAzureDevOpsCredentials) Initializes a new instance of the BaseAzureDevOpsProjectSettings class.
BaseAzureDevOpsProjectSettings(Uri, string, IAzureDevOpsCredentials) Initializes a new instance of the BaseAzureDevOpsProjectSettings 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.

Extension Methods

Name Value Summary
Dump<BaseAzureDevOpsProjectSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BaseAzureDevOpsProjectSettings>(BaseAzureDevOpsProjectSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BaseAzureDevOpsProjectSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BaseAzureDevOpsProjectSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<BaseAzureDevOpsProjectSettings>(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<BaseAzureDevOpsProjectSettings>(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
Requires the Cake.Issues addin