Skip to content

Reference

Konstantin Lepeshenkov edited this page Dec 9, 2022 · 8 revisions

BuildClientAttribute type

Injects BuildHttpClient instance into your Function.

BuildDefinitionAttribute type

Binds to a BuildDefinitionProxy by its ID. Input only.

Id property

Build Definition ID (an integer number) to bind to.

BuildDefinitionProxy type

Represents a BuildDefinition instance.

BuildProxy type

Represents the Build object.

BuildStatusChangedTriggerAttribute type

Triggers a Function when a Build status is changed.

AgentPoolIds property

Comma-separated list of Agent Pool IDs. When specified, only Builds running in those Agent Pools will be observed.

BuildDefinitionIds property

Comma-separated list of Build Definition IDs. When specified, only Builds from those Build Definitions will be observed.

BuildNumber property

When specified, only builds with that particular Build Number will be observed. E.g. "20221102.5".

BuildReasons property

Comma-separated list of reasons for build to be triggered. When specified, only builds caused by those reasons will be observed. E.g. "Manual,PullRequest,Schedule".

FromValue property

When specified, the Function will only be triggered when Build Status changes FROM this value. E.g. "NotStarted".

RepositoryId property

When specified, only builds from that repository will be observed. E.g. "14BAE3DC-067A-4A07-8BA9-1223646C9F44". TODO: needs to be used together with RepositoryType, so doesn't work yet. Replace with RepositoryName.

RequestedFor property

When specified, only builds triggered by that particular person will be observed. E.g. "john@doe.com".

ToValue property

When specified, the Function will only be triggered when Build Status changes TO this value. List of allowed values: . E.g. "Completed".

GitClientAttribute type

Injects GitHttpClient instance into your Function.

ProjectAttribute type

Binds to a ProjectProxy by its name. Input only.

ProjectClientAttribute type

Injects ProjectHttpClient instance into your Function.

ProjectProxy type

Represents the TeamProject object.

PullRequestProxy type

Represents the GitPullRequest object.

PullRequestStatusChangedTriggerAttribute type

Triggered when a Pull Request changes its Status. Currently retries every 1 minute FOREVER. Make sure to handle your exceptions.

FromValue property

When specified, the Function will only be triggered when Pull Request Status changes FROM this value. Allowed values: PullRequestStatusEnum. E.g. "Draft".

Repository property

When specified, only Pull Requests in this Repository will be observed.

SourceBranch property

When specified, only Pull Requests from this Source Branch will be observed.

TargetBranch property

When specified, only Pull Requests into this Target Branch will be observed.

ToValue property

When specified, the Function will only be triggered when Pull Request Status changes TO this value. Allowed values: PullRequestStatusEnum. E.g. "Completed".

PullRequestStatusEnum type

Possible Pull Request statuses.

ReleaseClientAttribute type

Injects ReleaseHttpClient instance into your Function.

ReleaseCreatedTriggerAttribute type

Triggered when a new Release is created. Currently retries every 1 minute FOREVER. Make sure to handle your exceptions.

CreatedBy property

When specified, only Releases triggered by this user will be observed. E.g. "john@doe.com".

ReleaseDefinitionId property

When specified, only Releases from this Release Definition will be observed.

ReleaseFolderPath property

When specified, only Releases from this folder will be observed.

ReleaseEnvironmentAttribute type

Output-only binding for ReleaseEnvironmentProxy object.

ReleaseEnvironmentProxy type

Represents the ReleaseEnvironment (aka Release Stage) object

AllEnvironments property

References to all other Environments (Stages) of this Release. Navigate to them by their name.

ReleaseProxy property

Reference to parent Release

ResultValues property

Result Values of this Release Environment (Stage). To output a result value, create a shell (bash, cmd, etc.) task, that has "AzFunc4DevOps" in its name and prints "<AzFunc4DevOps.MyResult>my-value</AzFunc4DevOps.MyResult>" to stdout. Then "MyResult"="my-value" will appear in this map.

ReleaseEnvironmentStatus type

When returned from a Function, changes the state of given Release Environment (aka Release Stage)

ReleaseEnvironmentId property

ID of this Release Environment (Stage)

ReleaseId property

ID of the Release this Environment (Stage) belongs to.

ReleaseEnvironmentStatusAttribute type

Output-only binding for object. Used mostly for triggering Release Environments (Stages) and setting their Variables.

ReleaseEnvironmentStatusChangedTriggerAttribute type

Triggered when a Release Environment (Stage) changes its Status. Currently retries every 1 minute FOREVER. Make sure to handle your exceptions.

CreatedBy property

When specified, only Releases created by this user will be observed. E.g. "john@doe.com".

FromValue property

When specified, the Function will only be triggered when Release Environment Status changes FROM this value. Allowed values: EnvironmentStatus. E.g. "NotStarted".

ReleaseDefinitionId property

When specified, only Releases from this Release Definition will be observed.

ReleaseEnvironmentId property

When specified, only this particular Release Environment (Stage) will be observed.

ReleaseEnvironmentName property

When specified, only Release Environments (Stages) with this particular name will be observed. E.g. "Stage 1".

ReleaseFolderPath property

When specified, only Releases from this Folder will be observed.

ToValue property

When specified, the Function will only be triggered when Release Environment Status changes TO this value. Allowed values: EnvironmentStatus. E.g. "Succeeded".

ReleaseProxy type

Represents the Release object

TestAttachmentProxy type

Represents a Test Case Step File Attachment

TestCaseAttribute type

Binds to a TestCaseProxy (a Work Item with Type = "Test Case"). Input/Output.

TestCaseId type

Combines Test Case ID and a list of Test Configuration Ids ('Windows', 'Linux' etc.) assigned to it.

ConfigurationIds property

(Optional) IDs of Test Configurations assigned to this Test Case.

Id property

Work Item ID of this Test Case.

TestCaseProxy type

Represents the 'Test Case' work item.

TestSteps property

List of Steps in this Test Case

TestPlanClientAttribute type

Injects TestPlanHttpClient instance into your Function.

TestStepProxy type

Represents a Test Case Step

Attachments property

List of attachments (screenshots, images, documents etc.), that belong to this Test Step.

Description property

Arbitrary description.

ExpectedResult property

Expected result of this step. E.g. "Browser windows opens".

Id property

ID of this Test Step.

SharedStepId property

If this is a shared step, here comes its ID.

TestStepType property

Test Step Type. Allowed values: TestStepType

Title property

Action text. E.g. "Open browser window".

TestPlanAttribute type

Binds to a TestPlanProxy (a collection of Test Cases). Input/Output.

Id property

ID of Test Plan to bind to. Integer number. Required.

TestSuiteAttribute type

Binds to a TestSuiteProxy (a collection of Test Cases). Input/Output.

Id property

(Optional) ID of a particular Test Suite. If not specified, binds to parent Test Plan's Root (aka default) Test Suite.

PlanId property

ID of parent Test Plan. Integer number. Required.

TestPlanProxy type

Represents the 'Test Plan' object.

OriginalJson property

Snapshot of this object, in JSON form. Used for change detection.

TestSuiteProxy type

Represents the 'Test Suite' object.

OriginalJson property

Snapshot of this object, in JSON form. Used for change detection.

TestCases property

List of Test Cases in this Test Suite.

VssConnectionAttribute type

Injects VssConnection instance into your Function.

WorkClientAttribute type

Injects WorkHttpClient instance into your Function.

WorkItemAttribute type

Binds to a WorkItemProxy (a generic Work Item instance). Input/Output.

Id property

ID of a Work Item to bind to. Should only be used for Input bindings.

WorkItemChange type

Represents a change in a Work Item. Used as a Function's parameter type for WorkItemChangedTriggerAttribute.

NewVersion property

The new state of a Work Item.

OldVersion property

The previous state of a Work Item.

WorkItemChangedTriggerAttribute type

Triggers a Function when a Work Item is changed. Changes are detected by watching Work Item's revision numbers. Function's parameter should be of WorkItemChange type. Currently retries every 1 minute FOREVER. Make sure to handle your exceptions. Use WiqlQueryWhereClause property to restrict the kind of Work Items to be triggered for.

FieldName property

Name of specific Field to watch for changes in. E.g. "System.Title". When specified, the Function will only be triggered when that Field's value changes.

FromValue property

Should be used together with FieldName. When specified, the Function will only be triggered when that Field's value changes FROM this value to some other value.

ToValue property

Should be used together with FieldName. When specified, the Function will only be triggered when that Field's value changes TO this value.

WiqlQueryWhereClause property

WIQL WHERE filter. E.g. "[Work Item Type] = 'User Story'". When specified, the Function will only be triggered for items, that satisfy that filter.

WorkItemClientAttribute type

Injects WorkHttpClient instance into your Function.

WorkItemCreatedTriggerAttribute type

Triggered when a new Work Item is created. Currently retries every 1 minute FOREVER. Make sure to handle your exceptions. Use WiqlQueryWhereClause property to restrict the kind of Work Items to be triggered for.

WiqlQueryWhereClause property

WIQL WHERE filter. E.g. "[Work Item Type] = 'User Story'". When specified, the Function will only be triggered for items, that satisfy that filter.

WorkItemProxy type

Represents a generic Work Item.

AreaId property

System.AreaId field.

AreaPath property

System.AreaPath field.

AuthorizedDate property

System.AuthorizedDate field.

ChangedBy property

System.ChangedBy field.

ChangedDate property

System.ChangedDate field.

CompletedWork property

Microsoft.VSTS.Scheduling.CompletedWork field.

CreatedBy property

System.CreatedBy field.

CreatedDate property

System.CreatedDate field.

Description property

System.Description field.

Effort property

Microsoft.VSTS.Scheduling.Effort field.

IterationId property

System.IterationId field.

IterationPath property

System.IterationPath field.

OriginalEstimate property

Microsoft.VSTS.Scheduling.OriginalEstimate field.

OriginalJson property

Snapshot of this object, in JSON form. Used for change detection.

Parent property

System.Parent field.

Priority property

Microsoft.VSTS.Common.Priority field.

Reason property

System.Reason field.

RemainingWork property

Microsoft.VSTS.Scheduling.RemainingWork field.

RevisedDate property

System.RevisedDate field.

Severity property

Microsoft.VSTS.Common.Severity field.

State property

System.State field.

TeamProject property

System.TeamProject field.

Title property

System.Title field.

WorkItemType property

System.WorkItemType field.

WorkItemsAttribute type

Binds to an IEnumerable of WorkItemProxy. Use WiqlQueryWhereClause property to specify a WIQL query for items to be returned.

WiqlQueryWhereClause property

WIQL WHERE filter for Work Items to be returned. E.g. "[Work Item Type] = 'User Story'".

Clone this wiki locally