AzurePipelinesEnvironmentInfo Class

Summary

Provides Azure Pipelines environment 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["AzurePipelinesEnvironmentInfo"] class Type type-node

Syntax

public sealed class AzurePipelinesEnvironmentInfo : AzurePipelinesInfo

Constructors

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

Properties

Name Value Summary
Agent AzurePipelinesAgentInfo
Gets Azure Pipelines agent information.
Build AzurePipelinesBuildInfo
Gets Azure Pipelines Build information.
BuildDefinition AzurePipelinesDefinitionInfo
Gets Azure Pipelines Build Definition information.
PullRequest AzurePipelinesPullRequestInfo
Gets Azure Pipelines pull request information.
Repository AzurePipelinesRepositoryInfo
Gets Azure Pipelines repository information.
TeamProject AzurePipelinesTeamProjectInfo
Gets Azure Pipeline Team Project information.

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