AzurePipelinesInfo Class

Summary

Base class used to provide information about the Azure Pipelines environment.
graph BT Type-->Base0["object"] Type["AzurePipelinesInfo"] class Type type-node Derived0["AzurePipelinesRepositoryInfo"]-->Type click Derived0 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesRepositoryInfo" Derived1["AzurePipelinesAgentInfo"]-->Type click Derived1 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesAgentInfo" Derived2["AzurePipelinesEnvironmentInfo"]-->Type click Derived2 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesEnvironmentInfo" Derived3["AzurePipelinesTriggeredBy"]-->Type click Derived3 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesTriggeredBy" Derived4["AzurePipelinesDefinitionInfo"]-->Type click Derived4 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesDefinitionInfo" Derived5["AzurePipelinesTeamProjectInfo"]-->Type click Derived5 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesTeamProjectInfo" Derived6["AzurePipelinesBuildInfo"]-->Type click Derived6 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesBuildInfo" Derived7["AzurePipelinesPullRequestInfo"]-->Type click Derived7 "/api/Cake.Common.Build.AzurePipelines.Data/AzurePipelinesPullRequestInfo"

Syntax

public abstract class AzurePipelinesInfo

Constructors

Name Summary
AzurePipelinesInfo(ICakeEnvironment) Initializes a new instance of the AzurePipelinesInfo class.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
GetEnvironmentString(string) string
Gets an environment variable as a string.
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.
GetRepositoryType(string) AzurePipelinesRepositoryType?
Gets the current repository type as a AzurePipelinesRepositoryType from an environment variable.

Extension Methods

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