AzurePipelinesAgentInfo Class

Summary

Provides Azure Pipelines agent info for the current build and build agent.
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["AzurePipelinesAgentInfo"] class Type type-node

Syntax

public sealed class AzurePipelinesAgentInfo : AzurePipelinesInfo

Constructors

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

Properties

Name Value Summary
BuildDirectory FilePath
Gets the local path on the agent where all folders for a given build definition are created.
HomeDirectory FilePath
Gets the directory the agent is installed into. This contains the agent software.
Id int
Gets the ID of the agent.
IsHosted bool
Gets a value indicating whether the current agent is a Microsoft hosted agent.
JobName string
Gets the display name of the running job.
JobStatus string
Gets the status of the build.
MachineName string
Gets the name of the machine on which the agent is installed.
Name string
Gets the name of the agent that is registered with the pool.
ToolsDirectory FilePath
Gets the directory used by tasks such as Node Tool Installer and Use Python Version to switch between multiple versions of a tool.
WorkingDirectory FilePath
Gets the working directory for this agent.

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