Summary

Provides Azure Pipelines Build info for the current build.

Namespace

Cake.Common.Build.AzurePipelines.Data

Base Types

object
AzurePipelinesInfo

graph BT Type-->Base0["AzurePipelinesInfo"] click Base0 "/api/Cake.Common.Build.AzurePipelines/AzurePipelinesInfo" Base0-->Base1["object"] Type["AzurePipelinesBuildInfo"] class Type type-node

Syntax

public sealed class AzurePipelinesBuildInfo : AzurePipelinesInfo

Constructors

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

Properties

Name	Value	Summary
AccessToken	string	Gets the a special variable that carries the security token used by the running build.
ArtifactStagingDirectory	DirectoryPath	Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
BinariesDirectory	DirectoryPath	Gets the local path on the agent you can use as an output folder for compiled binaries.
Debug	bool	Gets a value indicating whether more detailed logs to debug pipeline problems is enabled.
Id	int	Gets the ID of the record for the completed build.
Number	string	Gets the name of the completed build.
QueuedBy	string	Gets the user who queued the build.
Reason	string	Gets the event that caused the build to run.
RequestedFor	string	Gets the user the build was requested for.
RequestedForEmail	string	Gets the email of the user the build was requested for.
SourcesDirectory	DirectoryPath	Gets the local path on the agent where your source code files are downloaded.
StagingDirectory	DirectoryPath	Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
TestResultsDirectory	DirectoryPath	Gets local path on the agent where the test results are created.
TriggeredBy	AzurePipelinesTriggeredBy	Gets Azure Pipelines Build TriggeredBy information.
Uri	Uri	Gets the URI for the 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