Class AzurePipelines

Namespace

DotNetDo

Assembly

DotNetDo.Core.dll

Exposes Azure Pipelines logging commands and predefined metadata.

public sealed class AzurePipelines

Properties

Agent

The Agent metadata read from the provider environment.

public AzureAgentMetadata Agent { get; }

Property Value

AzureAgentMetadata

Build

The Build metadata read from the provider environment.

public AzureBuildMetadata Build { get; }

Property Value

AzureBuildMetadata

Deployment

The Deployment metadata read from the provider environment.

public AzureDeploymentMetadata Deployment { get; }

Property Value

AzureDeploymentMetadata

Pipeline

The Pipeline metadata read from the provider environment.

public AzurePipelineMetadata Pipeline { get; }

Property Value

AzurePipelineMetadata

Release

The Release metadata read from the provider environment.

public AzureReleaseMetadata Release { get; }

Property Value

AzureReleaseMetadata

System

The System metadata read from the provider environment.

public AzureSystemMetadata System { get; }

Property Value

AzureSystemMetadata

Methods

AddAttachment(AbsolutePath, string, string)

Emits the provider's AddAttachment command immediately.

public void AddAttachment(AbsolutePath path, string type, string name)

Parameters

path AbsolutePath

type string

name string

AddBuildTag(string)

Emits the provider's AddBuildTag command immediately.

public void AddBuildTag(string tag)

Parameters

tag string

AssociateArtifact(string, AzureArtifactType, string)

Emits the provider's AssociateArtifact command immediately.

public void AssociateArtifact(string artifactName, AzureArtifactType type, string location)

Parameters

artifactName string

type AzureArtifactType

location string

AssociateArtifact(string, string, Uri)

Associates an artifact using a provider-defined custom type.

public void AssociateArtifact(string artifactName, string artifactType, Uri location)

Parameters

artifactName string

artifactType string

location Uri

Command(string)

Emits the provider's Command command immediately.

public void Command(string message)

Parameters

message string

Complete(string?, AzureTaskResult?)

Emits the provider's Complete command immediately.

public void Complete(string? message = null, AzureTaskResult? result = null)

Parameters

message string?

result AzureTaskResult?

Debug(string)

Emits the provider's Debug command immediately.

public void Debug(string message)

Parameters

message string

EndGroup()

Emits the provider's EndGroup command immediately.

public void EndGroup()

Error(string)

Emits the provider's Error command immediately.

public void Error(string message)

Parameters

message string

LogDetail(string, AzureLogDetail)

Emits the provider's LogDetail command immediately.

public void LogDetail(string operation, AzureLogDetail options)

Parameters

operation string

options AzureLogDetail

LogIssue(string, AzureLogIssue)

Emits the provider's LogIssue command immediately.

public void LogIssue(string message, AzureLogIssue options)

Parameters

message string

options AzureLogIssue

PrependPath(AbsolutePath)

Emits the provider's PrependPath command immediately.

public void PrependPath(AbsolutePath path)

Parameters

path AbsolutePath

Section(string)

Emits the provider's Section command immediately.

public void Section(string message)

Parameters

message string

SetEndpoint(string, AzureEndpointField, string, string?)

Emits the provider's SetEndpoint command immediately.

public void SetEndpoint(string id, AzureEndpointField field, string value, string? key = null)

Parameters

id string

field AzureEndpointField

value string

key string?

SetProgress(int, string)

Emits the provider's SetProgress command immediately.

public void SetProgress(int progress, string operation)

Parameters

progress int

operation string

SetSecret(string)

Emits the provider's SetSecret command immediately.

public void SetSecret(string value)

Parameters

value string

SetVariable(string, string, AzureVariableOptions?)

Emits the provider's SetVariable command immediately.

public void SetVariable(string name, string value, AzureVariableOptions? options = null)

Parameters

name string

value string

options AzureVariableOptions?

StartGroup(string)

Emits the provider's StartGroup command immediately.

public void StartGroup(string title)

Parameters

title string

UpdateBuildNumber(string)

Emits the provider's UpdateBuildNumber command immediately.

public void UpdateBuildNumber(string number)

Parameters

number string

UpdateReleaseName(string)

Emits the provider's UpdateReleaseName command immediately.

public void UpdateReleaseName(string name)

Parameters

name string

UploadArtifact(AbsolutePath, string, string?)

Emits the provider's UploadArtifact command immediately.

public void UploadArtifact(AbsolutePath path, string artifactName, string? containerFolder = null)

Parameters

path AbsolutePath

artifactName string

containerFolder string?

UploadFile(AbsolutePath)

Emits the provider's UploadFile command immediately.

public void UploadFile(AbsolutePath path)

Parameters

path AbsolutePath

UploadLog(AbsolutePath)

Emits the provider's UploadLog command immediately.

public void UploadLog(AbsolutePath path)

Parameters

path AbsolutePath

UploadSummary(AbsolutePath)

Emits the provider's UploadSummary command immediately.

public void UploadSummary(AbsolutePath path)

Parameters

path AbsolutePath

Warning(string)

Emits the provider's Warning command immediately.

public void Warning(string message)

Parameters

message string