AzurePipelinesTriggeredBy Class

Summary

Provides Azure Pipelines Trigger information for the current build.
Namespace
Cake.Common.Build.AzurePipelines.Data
Base Types
graph BT Type-->Base0["AzurePipelinesInfo"] click Base0 "/api/Cake.Common.Build.AzurePipelines/AzurePipelinesInfo" Base0-->Base1["object"] Type["AzurePipelinesTriggeredBy"] class Type type-node

Syntax

public class AzurePipelinesTriggeredBy : AzurePipelinesInfo

Remarks

Only populated if the build was triggered by another build.

Constructors

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

Properties

Name Value Summary
BuildId int
Gets the BuildID of the triggering build.
BuildNumber string
Gets the number of the triggering build.
DefinitionId int
Gets the DefinitionID of the triggering build.
DefinitionName string
Gets the name of the triggering build pipeline.
ProjectId string
Gets the ID of the project that contains the triggering build.

Methods

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

Extension Methods

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