BaseAzureDevOpsCollectionSettings Class

Summary

Base settings for aliases scoped to collection level.
graph BT Type-->Base0["BaseAzureDevOpsCredentialsSettings"] click Base0 "/api/Cake.AzureDevOps/BaseAzureDevOpsCredentialsSettings" Base0-->Base1["Object"] Type["BaseAzureDevOpsCollectionSettings"] class Type type-node Derived0["BaseAzureDevOpsProjectSettings"]-->Type click Derived0 "/api/Cake.AzureDevOps/BaseAzureDevOpsProjectSettings"

Syntax

public abstract class BaseAzureDevOpsCollectionSettings : BaseAzureDevOpsCredentialsSettings

Constructors

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

Extension Methods

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